Package org.craftercms.studio.api.v2.service.clipboard

Interface ClipboardService

All Known Implementing Classes:

ClipboardServiceImpl

public interface ClipboardService

Defines all clipboard related operations

Since:

3.2

Author:

joseross

Method Summary

Modifier and Type	Method	Description
String	duplicateItem(String siteId, String path)	Duplicates the given item
List<String>	pasteItems(String siteId, Operation operation, String targetPath, PasteItem item)	Performs the given clipboard operation

Method Detail

pasteItems

List<String> pasteItems(String siteId,
                        Operation operation,
                        String targetPath,
                        PasteItem item)
                 throws ServiceLayerException,
                        UserNotFoundException

Performs the given clipboard operation

Parameters:

siteId - the id of the site

operation - the clipboard operation

targetPath - the target path

item - the item to paste

Returns:

the list of pasted items

Throws:

ServiceLayerException - if there is any error during the operation

UserNotFoundException - if the user is not found

duplicateItem

String duplicateItem(String siteId,
                     String path)
              throws ServiceLayerException,
                     UserNotFoundException

Duplicates the given item

Parameters:

siteId - the id of the site

path - the path of the item

Returns:

the path of the new item

Throws:

ServiceLayerException - if there is any error copying the item

UserNotFoundException - if the user is not found