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, 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 String	CE_SYSTEM_PROPS
protected CMSComponentDao	cmsComponentDao Deprecated. Implement the CMSComponentDao as own property
protected List	systemProperties Deprecated. Implement the systemProperties as own property
protected TypeService	typeService Deprecated. Implement the TypeService as own property

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

ACTIVECATALOGVERSION, ACTIVESITE

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	createAndAddCmsComponent(ContentSlotModel contentSlot, String composedTypeCode, String id, String name) Deprecated.
AbstractCMSComponentModel	createCmsComponent(ContentSlotModel contentSlotModel, String componentUid, String componentName, String typeCode) Creates cms component model.
AbstractCMSComponentModel	createCMSComponent(ContentSlotModel contentSlot, String composedTypeCode, String id, String name) Deprecated.
void	deleteCMSComponent(AbstractCMSComponentModel component) Deprecated.
SearchResult<AbstractCMSComponentModel>	findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel, 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
String	generateCmsComponentUid() Generates a new CMS component UID
List<AbstractCMSComponentModel>	getAllCMSComponentsForCatalogVersion(CatalogVersionModel catalogVersionModel) gets all cms components for a given catalog.
Collection<ComposedTypeModel>	getAllowedCMSComponentContainers() Gets the allowed cms component containers.
Collection<ComposedTypeModel>	getAllowedCMSComponents() Gets the allowed cms components.
AbstractCMSComponentModel	getCMSComponent(String id) Deprecated.
AbstractCMSComponentContainerModel	getCMSComponentContainer(String id) Deprecated.
AbstractCMSComponentContainerModel	getCMSComponentContainerForId(String id) Gets the cms component container for id.
protected CMSComponentContainerRegistry	getCmsComponentContainerRegistry()
AbstractCMSComponentModel	getCMSComponentForId(String id) Gets the cms component for id.
Collection<AbstractCMSComponentModel>	getCMSComponentsForContainer(AbstractCMSComponentContainerModel container) Get the collection of components that should be provided when a container component is requested.
Collection<SimpleCMSComponentModel>	getCMSComponentsForContainerId(String containerId) Gets the cms components of container.
Collection<SimpleCMSComponentModel>	getCMSComponentsOfContainer(String containerId) Gets the cms components of container.
protected PersistentKeyGenerator	getComponentUidGenerator()
protected Collection<ComposedTypeModel>	getComposedTypeOfCode(String code)
protected Collection<AbstractCMSComponentModel>	getDisplayedComponentsForComponent(AbstractCMSComponentModel component) Get a collection of components that are displayed based on the given component.
Collection<AbstractCMSComponentModel>	getDisplayedComponentsForContentSlot(ContentSlotModel contentSlot) Get the collection of displayed components within a content slot.
Collection<String>	getEditorProperties(ItemModel component) Get all editor properties for the given content element.
Collection<String>	getSystemProperties(AbstractCMSComponentModel component) Get all system properties for the given content element.
protected 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	save(AbstractCMSComponentModel component) Deprecated.
void	setCmsComponentContainerRegistry(CMSComponentContainerRegistry cmsComponentContainerRegistry)
void	setCmsComponentDao(CMSComponentDao cmsComponentDao)
void	setComponentUidGenerator(PersistentKeyGenerator componentUidGenerator)
void	setSystemProperties(List systemProperties)
void	setTypeService(TypeService typeService)

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

getActiveCatalogVersion, getActiveSite, getUserService, 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, setTenantScope, 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 String CE_SYSTEM_PROPS

See Also:

Constant Field Values

typeService

@Deprecated
protected TypeService typeService

Deprecated. Implement the TypeService as own property

cmsComponentDao

@Deprecated
protected CMSComponentDao cmsComponentDao

Deprecated. Implement the CMSComponentDao as own property

systemProperties

@Deprecated
protected List systemProperties

Deprecated. Implement the systemProperties as own property

Constructor Detail

DefaultCMSAdminComponentService

public DefaultCMSAdminComponentService()

Method Detail

createAndAddCmsComponent

@Deprecated
public AbstractCMSComponentModel createAndAddCmsComponent(ContentSlotModel contentSlot,
                                                                      String composedTypeCode,
                                                                      String id,
                                                                      String name)
                                                               throws CMSItemCreateException

Deprecated.

Creates cms component model and adds it to passed as parameter content slot. This method explicitly calls ModelService.save(Object) on create cms component model.

Specified by:

createAndAddCmsComponent in interface CMSAdminComponentService

Parameters:

contentSlot - the content slot

composedTypeCode - the composed type code for new cms component

id - the id for new cms component

name - the name for new cms component

Returns:

the cms component model

Throws:

CMSItemCreateException - thrown when there was an problem to find composed type with code composedTypeCode for new cms component.

createCmsComponent

public AbstractCMSComponentModel createCmsComponent(ContentSlotModel contentSlotModel,
                                                    String componentUid,
                                                    String componentName,
                                                    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 String generateCmsComponentUid()

Description copied from interface: CMSAdminComponentService

Generates a new CMS component UID

Specified by:

generateCmsComponentUid in interface CMSAdminComponentService

Returns:

a newly generated component UID

createCMSComponent

@Deprecated
public AbstractCMSComponentModel createCMSComponent(ContentSlotModel contentSlot,
                                                                String composedTypeCode,
                                                                String id,
                                                                String name)
                                                         throws CMSItemCreateException

Deprecated.

Creates cms component model.

Specified by:

createCMSComponent in interface CMSAdminComponentService

Returns:

the cms component model

Throws:

CMSItemCreateException

deleteCMSComponent

@Deprecated
public void deleteCMSComponent(AbstractCMSComponentModel component)

Deprecated.

Deletes cms component.

Specified by:

deleteCMSComponent in interface CMSAdminComponentService

Parameters:

component - the component model to delete.

getAllowedCMSComponentContainers

public Collection<ComposedTypeModel> getAllowedCMSComponentContainers()

Gets the allowed cms component containers.

Specified by:

getAllowedCMSComponentContainers in interface CMSAdminComponentService

Returns:

the allowed cms component containers

getAllowedCMSComponents

public Collection<ComposedTypeModel> getAllowedCMSComponents()

Gets the allowed cms components.

Specified by:

getAllowedCMSComponents in interface CMSAdminComponentService

Returns:

the allowed cms components

getCMSComponent

@Deprecated
public AbstractCMSComponentModel getCMSComponent(String id)
                                                      throws CMSItemNotFoundException

Deprecated.

Gets the cms component for id.

Specified by:

getCMSComponent in interface CMSAdminComponentService

Parameters:

id - the id of cms component

Returns:

found cms component

Throws:

CMSItemNotFoundException - thrown when no cms comoponent has been found

getCMSComponentContainer

@Deprecated
public AbstractCMSComponentContainerModel getCMSComponentContainer(String id)
                                                                        throws CMSItemNotFoundException

Deprecated.

Gets the cms component container for id.

Specified by:

getCMSComponentContainer in interface CMSAdminComponentService

Parameters:

id - the id of cms component container.

Returns:

found cms component container.

Throws:

CMSItemNotFoundException - thrown when no cms comoponent container has been found

getCMSComponentContainerForId

public AbstractCMSComponentContainerModel getCMSComponentContainerForId(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(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

getCMSComponentsForContainerId

public Collection<SimpleCMSComponentModel> getCMSComponentsForContainerId(String containerId)

Gets the cms components of container.

Specified by:

getCMSComponentsForContainerId in interface CMSAdminComponentService

Parameters:

containerId - the container id

Returns:

he collection of cms components of container

getCMSComponentsOfContainer

public Collection<SimpleCMSComponentModel> getCMSComponentsOfContainer(String containerId)
                                                                throws CMSItemNotFoundException

Gets the cms components of container.

Specified by:

getCMSComponentsOfContainer in interface CMSAdminComponentService

Parameters:

containerId - the container id

Returns:

the collection of cms components of container

Throws:

CMSItemNotFoundException - thrown when no object has been found

getEditorProperties

public Collection<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 Collection<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 List<AbstractCMSComponentModel> getAllCMSComponentsForCatalogVersion(CatalogVersionModel catalogVersionModel)

Description copied from interface: CMSAdminComponentService

gets all cms components for a given catalog.

Specified by:

getAllCMSComponentsForCatalogVersion in interface CMSAdminComponentService

Returns:

all components for a given catalog version

save

@Deprecated
public void save(AbstractCMSComponentModel component)

Deprecated.

Saves cms component model.

Specified by:

save in interface CMSAdminComponentService

Parameters:

component - the component model to save.

getCMSComponentsForContainer

public 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 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

getDisplayedComponentsForComponent

protected 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 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

setCmsComponentDao

public void setCmsComponentDao(CMSComponentDao cmsComponentDao)

setSystemProperties

public void setSystemProperties(List systemProperties)

setTypeService

public void setTypeService(TypeService typeService)

getComposedTypeOfCode

protected Collection<ComposedTypeModel> getComposedTypeOfCode(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,
                                                                           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