de.hybris.platform.cms2.servicelayer.services

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 Type	Method and Description
<T extends AbstractCMSComponentModel> T	getAbstractCMSComponent(String id) Gets the abstract cms component.
<T extends AbstractCMSComponentModel> T	getAbstractCMSComponent(String id, Collection<CatalogVersionModel> catalogVersions) Gets the abstract cms component.
<T extends AbstractCMSComponentModel> T	getAbstractCMSComponent(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions) Gets the abstract cms component.
Collection<String>	getEditorProperties(AbstractCMSComponentModel component) Get all editor properties for the given content element.
<T extends SimpleCMSComponentModel> T	getSimpleCMSComponent(String id) Gets the simple cms component.
Collection<String>	getSystemProperties(AbstractCMSComponentModel component) Get all system properties for the given content element.
Boolean	isCmsComponentRestricted(AbstractCMSComponentModel component) Deprecated. use isComponentRestricted(AbstractCMSComponentModel) instead.
boolean	isComponentContainer(String componentTypeCode) Checks if component is a container.
boolean	isComponentRestricted(AbstractCMSComponentModel component) Checks if passed as parameter AbstractCMSComponentModel is restricted restricted.
Boolean	isContainer(String componentTypeCode) Deprecated. use isComponentContainer(String) instead.

Method Detail

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

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 get

catalogVersions - 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 get

contentSlotId - the content slot id

catalogVersions - the catalog versions

Returns:

the abstract cms component

Throws:

CMSItemNotFoundException - thrown when item was not found

getEditorProperties

Collection<String> getEditorProperties(AbstractCMSComponentModel 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

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

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:

collection of all system properties for component

isCmsComponentRestricted

@Deprecated
Boolean isCmsComponentRestricted(AbstractCMSComponentModel component)

Deprecated. use isComponentRestricted(AbstractCMSComponentModel) instead.

Checks if passed as parameter AbstractCMSComponentModel is restricted restricted.

Parameters:

component - the component which is checked against any restrictions

Returns:

Boolean.TRUE if is restricted, Boolean.FALSE otherwise

isComponentRestricted

boolean isComponentRestricted(AbstractCMSComponentModel component)

Checks if passed as parameter AbstractCMSComponentModel is restricted restricted.

Parameters:

component - the component which is checked against any restrictions

Returns:

true if is restricted, false otherwise

isContainer

@Deprecated
Boolean isContainer(String componentTypeCode)

Deprecated. use isComponentContainer(String) instead.

Checks if component is a container.

Parameters:

componentTypeCode - the component's ComposedType code

Returns:

Boolean.TRUE if is component, Boolean.FALSE otherwise

isComponentContainer

boolean isComponentContainer(String componentTypeCode)

Checks if component is a container.

Parameters:

componentTypeCode - the component's ComposedType code

Returns:

Boolean.TRUE if is component, Boolean.FALSE otherwise