de.hybris.platform.cms2.servicelayer.services.admin.impl

Class DefaultCMSAdminComponentService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService

de.hybris.platform.cms2.servicelayer.services.admin.impl.DefaultCMSAdminComponentService

All Implemented Interfaces:

CMSAdminComponentService, java.io.Serializable

public class DefaultCMSAdminComponentService
extends AbstractCMSAdminService
implements CMSAdminComponentService

Default implementation of the component service.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CE_SYSTEM_PROPS

Fields inherited from class de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService

ACTIVECATALOGVERSION, ACTIVESITE, CLONE_CONTEXT, RESTORE_CONTEXT

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultCMSAdminComponentService()

Method Summary

Modifier and Type	Method and Description
AbstractCMSComponentModel	createCmsComponent(ContentSlotModel contentSlotModel, java.lang.String componentUid, java.lang.String componentName, java.lang.String typeCode) Creates cms component model.
SearchResult<AbstractCMSComponentModel>	findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel, java.lang.String mask, PageableData pageableData) For a given mask used as filter and a PageableData query, will return a page object consisting of the content list of the requested page number and the total number of entities for the given mask
java.lang.String	generateCmsComponentUid() Generates a new CMS component UID
java.util.List<AbstractCMSComponentModel>	getAllCMSComponentsForCatalogVersion(CatalogVersionModel catalogVersionModel) gets all cms components for a given catalog.
java.util.Collection<ComposedTypeModel>	getAllowedCMSComponentContainers() Gets the allowed cms component containers.
java.util.Collection<ComposedTypeModel>	getAllowedCMSComponents() Gets the allowed cms components.
AbstractCMSComponentContainerModel	getCMSComponentContainerForId(java.lang.String id) Gets the cms component container for id.
protected CMSComponentContainerRegistry	getCmsComponentContainerRegistry()
protected CMSComponentDao	getCmsComponentDao()
AbstractCMSComponentModel	getCMSComponentForId(java.lang.String id) Gets the cms component for id.
AbstractCMSComponentModel	getCMSComponentForIdAndCatalogVersions(java.lang.String id, java.util.Collection<CatalogVersionModel> catalogVersions) Gets the cms component matching the id by searching in the given catalog versions.
java.util.Collection<AbstractCMSComponentModel>	getCMSComponentsForContainer(AbstractCMSComponentContainerModel container) Get the collection of components that should be provided when a container component is requested.
protected java.util.Comparator<AbstractCMSComponentModel>	getCmsItemCatalogLevelComparator()
protected PersistentKeyGenerator	getComponentUidGenerator()
protected java.util.Collection<ComposedTypeModel>	getComposedTypeOfCode(java.lang.String code)
java.util.Collection<AbstractCMSComponentContainerModel>	getContainersForContentSlot(ContentSlotModel contentSlot) Gets the collection of containers within a content slot.
protected java.util.Collection<AbstractCMSComponentModel>	getDisplayedComponentsForComponent(AbstractCMSComponentModel component) Get a collection of components that are displayed based on the given component.
java.util.Collection<AbstractCMSComponentModel>	getDisplayedComponentsForContentSlot(ContentSlotModel contentSlot) Get the collection of displayed components within a content slot.
java.util.Collection<java.lang.String>	getEditorProperties(ItemModel component) Get all editor properties for the given content element.
protected java.util.List<java.lang.String>	getSystemProperties()
java.util.Collection<java.lang.String>	getSystemProperties(AbstractCMSComponentModel component) Get all system properties for the given content element.
protected TypeService	getTypeService()
protected java.lang.Boolean	isComponentContainer(AbstractCMSComponentModel component) Checks whether a given component is actually a container.
void	removeCMSComponentFromContentSlot(AbstractCMSComponentModel component, ContentSlotModel contentSlot) Removes the cms component from content slot.
void	setCmsComponentContainerRegistry(CMSComponentContainerRegistry cmsComponentContainerRegistry)
void	setCmsComponentDao(CMSComponentDao cmsComponentDao)
void	setCmsItemCatalogLevelComparator(java.util.Comparator<AbstractCMSComponentModel> cmsItemCatalogLevelComparator)
void	setComponentUidGenerator(PersistentKeyGenerator componentUidGenerator)
void	setSystemProperties(java.util.List<java.lang.String> systemProperties)
void	setTypeService(TypeService typeService)

Methods inherited from class de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService

getActiveCatalogVersion, getActiveSite, getBaseSiteService, getUserService, setBaseSiteService, setUserService

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CE_SYSTEM_PROPS

protected static final java.lang.String CE_SYSTEM_PROPS

See Also:

Constant Field Values

Constructor Detail

DefaultCMSAdminComponentService

public DefaultCMSAdminComponentService()

Method Detail

createCmsComponent

public AbstractCMSComponentModel createCmsComponent(ContentSlotModel contentSlotModel,
                                                    java.lang.String componentUid,
                                                    java.lang.String componentName,
                                                    java.lang.String typeCode)

Creates cms component model.

Specified by:

createCmsComponent in interface CMSAdminComponentService

Parameters:

contentSlotModel - the content slot

componentUid - the uid for the new cms component

componentName - the name for new cms component

typeCode - the composed type code for new cms component

Returns:

the cms component model

generateCmsComponentUid

public java.lang.String generateCmsComponentUid()

Generates a new CMS component UID

Specified by:

generateCmsComponentUid in interface CMSAdminComponentService

Returns:

a newly generated component UID

getAllowedCMSComponentContainers

public java.util.Collection<ComposedTypeModel> getAllowedCMSComponentContainers()

Gets the allowed cms component containers.

Specified by:

getAllowedCMSComponentContainers in interface CMSAdminComponentService

Returns:

the allowed cms component containers

getAllowedCMSComponents

public java.util.Collection<ComposedTypeModel> getAllowedCMSComponents()

Gets the allowed cms components.

Specified by:

getAllowedCMSComponents in interface CMSAdminComponentService

Returns:

the allowed cms components

getCMSComponentContainerForId

public AbstractCMSComponentContainerModel getCMSComponentContainerForId(java.lang.String id)
                                                                 throws AmbiguousIdentifierException,
                                                                        UnknownIdentifierException

Gets the cms component container for id.

Specified by:

getCMSComponentContainerForId in interface CMSAdminComponentService

Parameters:

id - the id of cms component container.

Returns:

found cms component container.

Throws:

AmbiguousIdentifierException - thrown when more than one object has been found.

UnknownIdentifierException - thrown when no object has been found

getCMSComponentForId

public AbstractCMSComponentModel getCMSComponentForId(java.lang.String id)
                                               throws AmbiguousIdentifierException,
                                                      UnknownIdentifierException

Gets the cms component for id.

Specified by:

getCMSComponentForId in interface CMSAdminComponentService

Parameters:

id - the id of cms component

Returns:

found cms component

Throws:

AmbiguousIdentifierException - thrown when more than one object has been found.

UnknownIdentifierException - thrown when no object has been found

getCMSComponentForIdAndCatalogVersions

public AbstractCMSComponentModel getCMSComponentForIdAndCatalogVersions(java.lang.String id,
                                                                        java.util.Collection<CatalogVersionModel> catalogVersions)
                                                                 throws UnknownIdentifierException

Gets the cms component matching the id by searching in the given catalog versions.

Specified by:

getCMSComponentForIdAndCatalogVersions in interface CMSAdminComponentService

Parameters:

id - the id of cms component

catalogVersions - the collection of catalog versions

Returns:

found cms component

Throws:

UnknownIdentifierException - thrown when no object has been found

getEditorProperties

public java.util.Collection<java.lang.String> getEditorProperties(ItemModel component)

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.

Specified by:

getEditorProperties in interface CMSAdminComponentService

Parameters:

component - the component which editor properties should be retrieved

Returns:

all editor properties

getSystemProperties

public java.util.Collection<java.lang.String> getSystemProperties(AbstractCMSComponentModel component)

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.

Specified by:

getSystemProperties in interface CMSAdminComponentService

Parameters:

component - the component which system properties should be retrieved

Returns:

all system properties

removeCMSComponentFromContentSlot

public void removeCMSComponentFromContentSlot(AbstractCMSComponentModel component,
                                              ContentSlotModel contentSlot)

Removes the cms component from content slot.

Specified by:

removeCMSComponentFromContentSlot in interface CMSAdminComponentService

Parameters:

component - the component to remove

contentSlot - the content slot from which the component will be removed.

getAllCMSComponentsForCatalogVersion

public java.util.List<AbstractCMSComponentModel> getAllCMSComponentsForCatalogVersion(CatalogVersionModel catalogVersionModel)

Description copied from interface: CMSAdminComponentService

gets all cms components for a given catalog.

Specified by:

getAllCMSComponentsForCatalogVersion in interface CMSAdminComponentService

Parameters:

catalogVersionModel - the catalog version model

Returns:

all components for a given catalog version

getCMSComponentsForContainer

public java.util.Collection<AbstractCMSComponentModel> getCMSComponentsForContainer(AbstractCMSComponentContainerModel container)

Description copied from interface: CMSAdminComponentService

Get the collection of components that should be provided when a container component is requested.

This service depends on a CMSComponentContainerStrategy to decide if:

• the container should return itself as the only container component
• the container should return its children as the container components
• the container should return container components based on a custom strategy

Specified by:

getCMSComponentsForContainer in interface CMSAdminComponentService

Parameters:

container - - the container model from which we want to get the components

Returns:

a collection of components that a container represents; never null

getDisplayedComponentsForContentSlot

public java.util.Collection<AbstractCMSComponentModel> getDisplayedComponentsForContentSlot(ContentSlotModel contentSlot)

Description copied from interface: CMSAdminComponentService

Get the collection of displayed components within a content slot. A displayed component is one that will be rendered by the storefront.

The difference between ContentSlotModel.getCmsComponents() and getting the displayed components in the slot has to do with containers. Some containers are rendered as a single component while some others are rendered as a collection of components or in other ways. So for container components, the #getCMSComponentsForContainer(AbstractCMSComponentContainerModel) method will be used.

Specified by:

getDisplayedComponentsForContentSlot in interface CMSAdminComponentService

Parameters:

contentSlot - - the content slot for which we want to get all displayed components

Returns:

a collection of components that are displayed for a given content slot; never null

getContainersForContentSlot

public java.util.Collection<AbstractCMSComponentContainerModel> getContainersForContentSlot(ContentSlotModel contentSlot)

Description copied from interface: CMSAdminComponentService

Gets the collection of containers within a content slot.

Specified by:

getContainersForContentSlot in interface CMSAdminComponentService

Parameters:

contentSlot - - the content slot for which to get all containers

Returns:

a collection of containers within the given content slot; never null

getDisplayedComponentsForComponent

protected java.util.Collection<AbstractCMSComponentModel> getDisplayedComponentsForComponent(AbstractCMSComponentModel component)

Get a collection of components that are displayed based on the given component. This will inspect the component to verify if the component is a container and if it is, then we will get all of the components for the given container; otherwise it will simply return a collection with only the component itself.

Parameters:

component - - the component from which to get the displayed components

Returns:

collections of components displayed for the given component; never null

isComponentContainer

protected java.lang.Boolean isComponentContainer(AbstractCMSComponentModel component)

Checks whether a given component is actually a container.

Parameters:

component - - the component to check

Returns:

true if the component is a container; false otherwise

getCmsComponentDao

protected CMSComponentDao getCmsComponentDao()

setCmsComponentDao

public void setCmsComponentDao(CMSComponentDao cmsComponentDao)

getSystemProperties

protected java.util.List<java.lang.String> getSystemProperties()

setSystemProperties

public void setSystemProperties(java.util.List<java.lang.String> systemProperties)

getTypeService

protected TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getComposedTypeOfCode

protected java.util.Collection<ComposedTypeModel> getComposedTypeOfCode(java.lang.String code)

getComponentUidGenerator

protected PersistentKeyGenerator getComponentUidGenerator()

setComponentUidGenerator

public void setComponentUidGenerator(PersistentKeyGenerator componentUidGenerator)

getCmsComponentContainerRegistry

protected CMSComponentContainerRegistry getCmsComponentContainerRegistry()

setCmsComponentContainerRegistry

public void setCmsComponentContainerRegistry(CMSComponentContainerRegistry cmsComponentContainerRegistry)

findByCatalogVersionAndMask

public SearchResult<AbstractCMSComponentModel> findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel,
                                                                           java.lang.String mask,
                                                                           PageableData pageableData)

Description copied from interface: CMSAdminComponentService

For a given mask used as filter and a PageableData query, will return a page object consisting of the content list of the requested page number and the total number of entities for the given mask

Specified by:

findByCatalogVersionAndMask in interface CMSAdminComponentService

Parameters:

catalogVersionModel - the catalog version to filter on

mask - the string value on which components will be filtered, implementations may choose to filter on the component name

pageableData - the PageableData object containing the page request details. PageableData may contain a String value for sort, this will be used by a sorting strategy to select the most appropriate query or resort to a default one.

Returns:

a page object

getCmsItemCatalogLevelComparator

protected java.util.Comparator<AbstractCMSComponentModel> getCmsItemCatalogLevelComparator()

setCmsItemCatalogLevelComparator

public void setCmsItemCatalogLevelComparator(java.util.Comparator<AbstractCMSComponentModel> cmsItemCatalogLevelComparator)