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

Interface ContentService

All Known Implementing Classes:

ContentServiceImpl

public interface ContentService

Method Summary

Modifier and Type	Method	Description
boolean	deleteContent(String siteId, String path, String submissionComment)	Delete content for given path.
boolean	deleteContent(String siteId, List<String> paths, String submissionComment)	Delete content for given paths.
List<String>	getChildItems(String siteId, String path)	Get child items for given path.
List<String>	getChildItems(String siteId, List<String> paths)	Get child items for given paths.
GetChildrenResult	getChildrenById(String siteId, String id, String locale, String keyword, List<String> excludes, String sortStrategy, String order, int offset, int limit)	Get list of children for given item id
GetChildrenResult	getChildrenByPath(String siteId, String path, String locale, String keyword, List<String> excludes, String sortStrategy, String order, int offset, int limit)	Get list of children for given path
InputStream	getContentByCommitId(String siteId, String path, String commitId)	Get content for commit id
org.craftercms.core.service.Item	getItem(String siteId, String path, boolean flatten)
DetailedItem	getItemById(String siteId, long id, boolean preferContent)	Get detailed item for given id
DetailedItem	getItemByPath(String siteId, String path, boolean preferContent)	Get detailed item for given path
List<QuickCreateItem>	getQuickCreatableContentTypes(String siteId)	Get list of content types marked as quick creatable for given site
List<SandboxItem>	getSandboxItemsById(String siteId, List<Long> ids, boolean preferContent)	Get sandbox items for given list of ids
List<SandboxItem>	getSandboxItemsByPath(String siteId, List<String> paths, boolean preferContent)	Get sandbox items for given list of paths
void	lockContent(String siteId, String path)	Lock item by path for given site
void	unlockContent(String siteId, String path)	Unlock item by path for given site

Method Detail

getQuickCreatableContentTypes

List<QuickCreateItem> getQuickCreatableContentTypes(String siteId)

Get list of content types marked as quick creatable for given site

Parameters:

siteId - site id to use

Returns:

list of content types

getChildItems

List<String> getChildItems(String siteId,
                           String path)

Get child items for given path. Child item is - belongs to item subtree - is item specific dependency

Parameters:

siteId - site identifier

path - path to get child items for

Returns:

list of paths of child items

getChildItems

List<String> getChildItems(String siteId,
                           List<String> paths)

Get child items for given paths. Child item is - belongs to item subtree - is item specific dependency

Parameters:

siteId - site identifier

paths - list of paths to get child items for

Returns:

list of paths of child items

deleteContent

boolean deleteContent(String siteId,
                      String path,
                      String submissionComment)
               throws ServiceLayerException,
                      AuthenticationException,
                      DeploymentException

Delete content for given path. Following content will be deleted: - given path - child items for given path

Parameters:

siteId - site identifier

path - content to be deleted

submissionComment - submission comment

Returns:

true if success, otherwise false

Throws:

ServiceLayerException - general service error

AuthenticationException - authentication error

DeploymentException - deployment error caused by delete

deleteContent

boolean deleteContent(String siteId,
                      List<String> paths,
                      String submissionComment)
               throws ServiceLayerException,
                      AuthenticationException,
                      DeploymentException

Delete content for given paths. Following content will be deleted: - given paths - child items for given paths

Parameters:

siteId - site identifier

paths - content to be deleted

submissionComment - submission comment

Returns:

true if success, otherwise false

Throws:

ServiceLayerException - general service error

AuthenticationException - authentication error

DeploymentException - deployment error caused by delete

getChildrenByPath

GetChildrenResult getChildrenByPath(String siteId,
                                    String path,
                                    String locale,
                                    String keyword,
                                    List<String> excludes,
                                    String sortStrategy,
                                    String order,
                                    int offset,
                                    int limit)
                             throws ServiceLayerException,
                                    UserNotFoundException,
                                    ContentNotFoundException

Get list of children for given path

Parameters:

siteId - site identifier

path - item path to children for

locale - filter children by locale

keyword - filter children by keyword

excludes - exclude items by regular expression patterns

sortStrategy - sort order

order - ascending or descending

offset - offset of the first child in the result

limit - number of children to return

Returns:

list of children

Throws:

ServiceLayerException

UserNotFoundException

ContentNotFoundException

getChildrenById

GetChildrenResult getChildrenById(String siteId,
                                  String id,
                                  String locale,
                                  String keyword,
                                  List<String> excludes,
                                  String sortStrategy,
                                  String order,
                                  int offset,
                                  int limit)
                           throws ServiceLayerException,
                                  UserNotFoundException

Get list of children for given item id

Parameters:

siteId - site identifier

id - item id to get children for

locale - filter children by locale

keyword - filter children by keyword

excludes - exclude items by regular expression patterns

sortStrategy - sort order

order - ascending or descending

offset - offset of the first child in the result

limit - number of children to return

Returns:

list of children

Throws:

ServiceLayerException

UserNotFoundException

getItem

org.craftercms.core.service.Item getItem(String siteId,
                                         String path,
                                         boolean flatten)

getItemByPath

DetailedItem getItemByPath(String siteId,
                           String path,
                           boolean preferContent)
                    throws ServiceLayerException,
                           UserNotFoundException

Get detailed item for given path

Parameters:

siteId - site identifier

path - item path

preferContent - if true return content item if available

Returns:

detailed item

Throws:

ServiceLayerException

UserNotFoundException

getItemById

DetailedItem getItemById(String siteId,
                         long id,
                         boolean preferContent)
                  throws ServiceLayerException,
                         UserNotFoundException

Get detailed item for given id

Parameters:

siteId - site identifier

id - item id

preferContent - if true return content item if available

Returns:

detailed item

Throws:

ServiceLayerException

UserNotFoundException

getSandboxItemsByPath

List<SandboxItem> getSandboxItemsByPath(String siteId,
                                        List<String> paths,
                                        boolean preferContent)
                                 throws ServiceLayerException,
                                        UserNotFoundException

Get sandbox items for given list of paths

Parameters:

siteId - site identifier

paths - list of paths to get sandbox items

preferContent - if true return content items if available

Returns:

list of sandbox items

Throws:

ServiceLayerException

UserNotFoundException

getSandboxItemsById

List<SandboxItem> getSandboxItemsById(String siteId,
                                      List<Long> ids,
                                      boolean preferContent)
                               throws ServiceLayerException,
                                      UserNotFoundException

Get sandbox items for given list of ids

Parameters:

siteId - site identifier

ids - list of ids to get sandbox items

preferContent - if true return content items if available

Returns:

list of sandbox items

Throws:

ServiceLayerException

UserNotFoundException

lockContent

void lockContent(String siteId,
                 String path)
          throws UserNotFoundException,
                 ServiceLayerException

Lock item by path for given site

Parameters:

siteId - site identifier

path - path to lock

Throws:

UserNotFoundException

ServiceLayerException

unlockContent

void unlockContent(String siteId,
                   String path)
            throws ContentNotFoundException,
                   ContentAlreadyUnlockedException

Unlock item by path for given site

Parameters:

siteId - site identifier

path - item path

Throws:

ContentNotFoundException

ContentAlreadyUnlockedException

getContentByCommitId

InputStream getContentByCommitId(String siteId,
                                 String path,
                                 String commitId)
                          throws ContentNotFoundException,
                                 IOException

Get content for commit id

Parameters:

siteId - site identifier

path - path of the content

commitId - commit id of the content version

Returns:

Throws:

ContentNotFoundException

IOException