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

Interface ContentTypeService

All Known Implementing Classes:

ContentTypeServiceImpl

public interface ContentTypeService

Defines all operations related to content-types

Since:

4.0

Author:

joseross

Method Summary

Modifier and Type	Method	Description
void	deleteContentType(String siteId, String contentType, boolean deleteDependencies)	Deletes all files related to a given content-type
org.apache.commons.lang3.tuple.ImmutablePair<String,org.springframework.core.io.Resource>	getContentTypePreviewImage(String siteId, String contentTypeId)	Finds the preview image for a given content-type
ContentTypeUsage	getContentTypeUsage(String siteId, String contentType)	Finds all items related to a given content-type

Method Detail

getContentTypeUsage

ContentTypeUsage getContentTypeUsage(String siteId,
                                     String contentType)
                              throws ServiceLayerException

Finds all items related to a given content-type

Parameters:

siteId - the id of the site

contentType - the id of the content-type

Returns:

the usage

Throws:

ServiceLayerException - if there is any error finding the items

getContentTypePreviewImage

org.apache.commons.lang3.tuple.ImmutablePair<String,org.springframework.core.io.Resource> getContentTypePreviewImage(String siteId,
                                                                                                                           String contentTypeId)
                                                                                                                    throws ServiceLayerException

Finds the preview image for a given content-type

Parameters:

siteId - the id of the site

contentTypeId - the id of the content-type

Returns:

the preview image file as a pair of path and resource

Throws:

ServiceLayerException - if there is any error finding the items

deleteContentType

void deleteContentType(String siteId,
                       String contentType,
                       boolean deleteDependencies)
                throws ServiceLayerException,
                       AuthenticationException,
                       DeploymentException,
                       UserNotFoundException

Deletes all files related to a given content-type

Parameters:

siteId - the id of the site

contentType - the id of the content-type

deleteDependencies - indicates if all dependencies should be deleted

Throws:

ServiceLayerException - if there is any error deleting the files

AuthenticationException - if there is any error authenticating the user

DeploymentException - if there is any error publishing the changes

UserNotFoundException