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

Interface CMSAdminComponentService

All Known Implementing Classes:

DefaultCMSAdminComponentService

public interface CMSAdminComponentService

The Interface CMSAdminComponentService is responsible for managing components and component containers.

Spring Bean ID:

cmsAdminComponentService

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. use createAndAddCmsComponent(ContentSlotModel, String, String, String) instead.
void	deleteCMSComponent(AbstractCMSComponentModel contentElement) Deprecated. use ModelService.remove(Object) instead.
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. use getCMSComponentForId(String) instead.
AbstractCMSComponentContainerModel	getCMSComponentContainer(String id) Deprecated. use getCMSComponentContainerForId(String) instead.
AbstractCMSComponentContainerModel	getCMSComponentContainerForId(String id) Gets the cms component container for id.
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) Deprecated. this method was never properly implemented and has no replacement.
Collection<SimpleCMSComponentModel>	getCMSComponentsOfContainer(String containerId) Deprecated. use getCMSComponentsForContainerId(String) instead.
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.
void	removeCMSComponentFromContentSlot(AbstractCMSComponentModel component, ContentSlotModel slotModel) Removes the cms component from content slot.
void	save(AbstractCMSComponentModel contentElement) Deprecated. use ModelService.save(Object) instead.

Method Detail

createCMSComponent

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

Deprecated. use createAndAddCmsComponent(ContentSlotModel, String, String, String) instead.

Creates cms component model.

Parameters:

contentSlot -

composedTypeCode -

id -

name -

Returns:

the cms component model

Throws:

CMSItemCreateException

createAndAddCmsComponent

@Deprecated
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.

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

AbstractCMSComponentModel createCmsComponent(ContentSlotModel contentSlotModel,
                                             String componentUid,
                                             String componentName,
                                             String typeCode)

Creates cms component model.

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

String generateCmsComponentUid()

Generates a new CMS component UID

Returns:

a newly generated component UID

deleteCMSComponent

@Deprecated
void deleteCMSComponent(AbstractCMSComponentModel contentElement)

Deprecated. use ModelService.remove(Object) instead.

Deletes cms component.

Parameters:

contentElement - the component model to delete.

getAllowedCMSComponentContainers

Collection<ComposedTypeModel> getAllowedCMSComponentContainers()

Gets the allowed cms component containers.

Returns:

the allowed cms component containers

getAllowedCMSComponents

Collection<ComposedTypeModel> getAllowedCMSComponents()

Gets the allowed cms components.

Returns:

the allowed cms components

getCMSComponent

@Deprecated
AbstractCMSComponentModel getCMSComponent(String id)
                                               throws CMSItemNotFoundException

Deprecated. use getCMSComponentForId(String) instead.

Gets the cms component for id.

Parameters:

id - the id of cms component

Returns:

found cms component

Throws:

CMSItemNotFoundException - thrown when no cms comoponent has been found

getCMSComponentContainer

@Deprecated
AbstractCMSComponentContainerModel getCMSComponentContainer(String id)
                                                                 throws CMSItemNotFoundException

Deprecated. use getCMSComponentContainerForId(String) instead.

Gets the cms component container for id.

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

AbstractCMSComponentContainerModel getCMSComponentContainerForId(String id)
                                                          throws AmbiguousIdentifierException,
                                                                 UnknownIdentifierException

Gets the cms component container for id.

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

AbstractCMSComponentModel getCMSComponentForId(String id)
                                        throws AmbiguousIdentifierException,
                                               UnknownIdentifierException

Gets the cms component for id.

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

getCMSComponentsOfContainer

@Deprecated
Collection<SimpleCMSComponentModel> getCMSComponentsOfContainer(String containerId)
                                                                     throws CMSItemNotFoundException

Deprecated. use getCMSComponentsForContainerId(String) instead.

Gets the cms components of container.

Parameters:

containerId - the container id

Returns:

the collection of cms components of container

Throws:

CMSItemNotFoundException - thrown when no object has been found

getCMSComponentsForContainerId

@Deprecated
Collection<SimpleCMSComponentModel> getCMSComponentsForContainerId(String containerId)

Deprecated. this method was never properly implemented and has no replacement.

Gets the cms components of container.

Parameters:

containerId - the container id

Returns:

he collection of cms components of container

getEditorProperties

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.

Parameters:

component - the component which editor properties should be retrieved

Returns:

all editor properties

getSystemProperties

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.

Parameters:

component - the component which system properties should be retrieved

Returns:

all system properties

removeCMSComponentFromContentSlot

void removeCMSComponentFromContentSlot(AbstractCMSComponentModel component,
                                       ContentSlotModel slotModel)

Removes the cms component from content slot.

Parameters:

component - the component to remove

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

getAllCMSComponentsForCatalogVersion

List<AbstractCMSComponentModel> getAllCMSComponentsForCatalogVersion(CatalogVersionModel catalogVersionModel)

gets all cms components for a given catalog.

Parameters:

catalogVersionModel -

Returns:

all components for a given catalog version

save

@Deprecated
void save(AbstractCMSComponentModel contentElement)

Deprecated. use ModelService.save(Object) instead.

Saves cms component model.

Parameters:

contentElement - the component model to save.

getCMSComponentsForContainer

Collection<AbstractCMSComponentModel> getCMSComponentsForContainer(AbstractCMSComponentContainerModel container)

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

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

Collection<AbstractCMSComponentModel> getDisplayedComponentsForContentSlot(ContentSlotModel contentSlot)

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.

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

findByCatalogVersionAndMask

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

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