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

Interface ContentTypeService

All Known Implementing Classes:

ContentTypeServiceImpl

public interface ContentTypeService

Author:

Dejan Brkic

Method Summary

Modifier and Type	Method	Description
boolean	changeContentType(String site, String path, String contentType)
List<ContentTypeConfigTO>	getAllContentTypes(String site, boolean searchable)
List<ContentTypeConfigTO>	getAllowedContentTypesForPath(String site, String relativePath)
String	getConfigPath()
ContentTypeConfigTO	getContentType(String site, String type)	get a content type by the given site and type name
ContentTypeConfigTO	getContentTypeByRelativePath(String site, String relativePath)
ContentTypeConfigTO	getContentTypeForContent(String site, String path)	get a content type by the given site and the content path
boolean	isUserAllowed(Set<String> userRoles, ContentTypeConfigTO item)	check if the user is allowed to access the content type with the given user roles

Method Detail

getContentTypeForContent

ContentTypeConfigTO getContentTypeForContent(String site,
                                             String path)
                                      throws ServiceLayerException

get a content type by the given site and the content path

Parameters:

site - site identifier

path - path of the content

Returns:

content type

Throws:

ServiceLayerException - general service error

isUserAllowed

boolean isUserAllowed(Set<String> userRoles,
                      ContentTypeConfigTO item)

check if the user is allowed to access the content type with the given user roles

Parameters:

userRoles - user roles

item - content type

Returns:

true if user has permissions to access the content type

getContentType

ContentTypeConfigTO getContentType(String site,
                                   String type)

get a content type by the given site and type name

Parameters:

site - site identifier

type - content type name

Returns:

content type

getContentTypeByRelativePath

ContentTypeConfigTO getContentTypeByRelativePath(String site,
                                                 String relativePath)
                                          throws ServiceLayerException

Throws:

ServiceLayerException

getAllContentTypes

List<ContentTypeConfigTO> getAllContentTypes(String site,
                                             boolean searchable)

getAllowedContentTypesForPath

List<ContentTypeConfigTO> getAllowedContentTypesForPath(String site,
                                                        String relativePath)

changeContentType

boolean changeContentType(String site,
                          String path,
                          String contentType)
                   throws ServiceLayerException,
                          UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

getConfigPath

String getConfigPath()