Interface CMSComponentService
- All Known Implementing Classes:
DefaultCMSComponentService
public interface CMSComponentService
The Interface CMSComponentService provides methods for managing cms components.
- Spring Bean ID:
- cmsComponentService
-
Method Summary
Modifier and TypeMethodDescription<T extends AbstractCMSComponentModel>
TGets the abstract cms component.<T extends AbstractCMSComponentModel>
TgetAbstractCMSComponent(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions) Gets the abstract cms component.<T extends AbstractCMSComponentModel>
TgetAbstractCMSComponent(String id, Collection<CatalogVersionModel> catalogVersions) Gets the abstract cms component.<T extends AbstractCMSComponentModel>
SearchPageData<T>getAbstractCMSComponents(Collection<String> ids, SearchPageData searchPageData) Gets the abstract cms component.<T extends AbstractCMSComponentModel>
SearchPageData<T>getAllAbstractCMSComponents(SearchPageData searchPageData) Gets all abstract cms components filtered by the specified pagination and sorting information.default Set<AbstractCMSComponentModel>getAllChildren(AbstractCMSComponentModel component) Get a CMSComponent's all children and children's children.default Set<AbstractCMSComponentModel>getAllParents(AbstractCMSComponentModel component) Get a CMSComponent's parent components and parents' parents.getEditorProperties(AbstractCMSComponentModel component) Get all editor properties for the given content element.Get all readable editor properties for the given content element.<T extends SimpleCMSComponentModel>
TGets the simple cms component.getSystemProperties(AbstractCMSComponentModel component) Get all system properties for the given content element.default booleaninSharedSlots(AbstractCMSComponentModel component) Check if a component is in shared slot or not.booleanisComponentContainer(String componentTypeCode) Checks if component is a container.booleanisComponentRestricted(AbstractCMSComponentModel component) Checks if passed as parameterAbstractCMSComponentModelis restricted restricted.booleanisComponentUsedOutsidePage(AbstractCMSComponentModel component, AbstractPageModel page) Checks if the component is used outside the page provided as reference.
-
Method Details
-
getAbstractCMSComponent
<T extends AbstractCMSComponentModel> T getAbstractCMSComponent(String id) throws CMSItemNotFoundException Gets the abstract cms component.- Type Parameters:
T- the generic type- Parameters:
id- the id of cms component to get- Returns:
- the abstract cms component
- Throws:
CMSItemNotFoundException- thrown when item was not found
-
getAbstractCMSComponents
<T extends AbstractCMSComponentModel> SearchPageData<T> getAbstractCMSComponents(Collection<String> ids, SearchPageData searchPageData) Gets the abstract cms component.- Type Parameters:
T- the AbstractCMSComponentModel subclass type- Parameters:
ids- the id collection of cms components to getsearchPageData- the searchPageData contains requested pagination and sorting information- Returns:
- the list of abstract cms component in SearchPageData; otherwise return an empty collection result when no component is found
-
getAllAbstractCMSComponents
<T extends AbstractCMSComponentModel> SearchPageData<T> getAllAbstractCMSComponents(SearchPageData searchPageData) Gets all abstract cms components filtered by the specified pagination and sorting information.- Type Parameters:
T- the AbstractCMSComponentModel subclass type- Parameters:
searchPageData- the searchPageData contains requested pagination and sorting information- Returns:
- the list of abstract cms component in SearchPageData; otherwise return an empty collection result when no component is found
-
getAbstractCMSComponent
<T extends AbstractCMSComponentModel> T getAbstractCMSComponent(String id, Collection<CatalogVersionModel> catalogVersions) throws CMSItemNotFoundException Gets the abstract cms component.- Type Parameters:
T- the generic type- Parameters:
id- the id of cms component to getcatalogVersions- the catalog versions- Returns:
- the abstract cms component
- Throws:
CMSItemNotFoundException- thrown when item was not found
-
getAbstractCMSComponent
<T extends AbstractCMSComponentModel> T getAbstractCMSComponent(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions) throws CMSItemNotFoundException Gets the abstract cms component.- Type Parameters:
T- the generic type- Parameters:
id- the id of cms component to getcontentSlotId- the content slot idcatalogVersions- the catalog versions- Returns:
- the abstract cms component
- Throws:
CMSItemNotFoundException- thrown when item was not found
-
getEditorProperties
Get all editor properties for the given content element. Editor-Properties are editorial properties, like headline, image and so on. Editor-Properties are used to display information on the frontend.- Parameters:
component- the component which editor properties should be retrieved- Returns:
- all editor properties
-
getReadableEditorProperties
Get all readable editor properties for the given content element. SeegetEditorProperties(AbstractCMSComponentModel)for retrieving all editor properties.- Parameters:
component- the component which editor properties should be retrieved- Returns:
- readable editor properties
-
getSimpleCMSComponent
<T extends SimpleCMSComponentModel> T getSimpleCMSComponent(String id) throws CMSItemNotFoundException Gets the simple cms component.- Type Parameters:
T- the generic type- Parameters:
id- the id of component to get- Returns:
- the simple cms component
- Throws:
CMSItemNotFoundException- thrown when item was not found
-
getSystemProperties
Get all system properties for the given content element. System-Properties are non editorial properties, like id, catalogVersion and so on. System-Properties are not used to display any information on the frontend.- Parameters:
component- the component which system properties should be retrieved- Returns:
- collection of all system properties for component
-
isComponentRestricted
Checks if passed as parameterAbstractCMSComponentModelis restricted restricted.- Parameters:
component- the component which is checked against any restrictions- Returns:
trueif is restricted,falseotherwise
-
isComponentContainer
Checks if component is a container.- Parameters:
componentTypeCode- the component'sComposedTypecode- Returns:
Boolean.TRUEif is component,Boolean.FALSEotherwise
-
isComponentUsedOutsidePage
Checks if the component is used outside the page provided as reference.- Parameters:
component- The component to check.page- The page used as reference.- Returns:
Boolean.TRUEif the component is used elsewhere.Boolean.FALSEif it's never used or if it's only used in the reference page.
-
getAllParents
Get a CMSComponent's parent components and parents' parents.- Parameters:
component- The CMS component.- Returns:
- List of all parents of a component.
-
getAllChildren
Get a CMSComponent's all children and children's children.- Parameters:
component- The CMS component.- Returns:
- List of all parents of a component.
-