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

Class DefaultCMSComponentService

java.lang.Object

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

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

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

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

All Implemented Interfaces:

CMSComponentService, Serializable

public class DefaultCMSComponentService
extends AbstractCMSService
implements CMSComponentService

Default implementation of CMSComponentService interface.

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

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

CURRENTCATALOGVERSION, CURRENTSITE

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
DefaultCMSComponentService() Constructor used to create new instance of DefaultCMSComponentService

Method Summary

Modifier and Type	Method and Description
AbstractCMSComponentModel	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.
SimpleCMSComponentModel	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.
void	setCatalogService(CatalogService catalogService)
void	setCmsComponentDao(CMSComponentDao cmsComponentDao)
void	setSystemProperties(List systemProperties)
void	setTypeService(TypeService typeService)

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

getBaseSiteService, getCurrentCatalogVersion, getCurrentSite, getSearchRestrictionService, getUserService, setBaseSiteService, setSearchRestrictionService, 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

cmsComponentDao

@Deprecated
protected CMSComponentDao cmsComponentDao

Deprecated. Implement the CMSComponentDao as own property

systemProperties

@Deprecated
protected List systemProperties

Deprecated. Implement the List as own property

typeService

@Deprecated
protected TypeService typeService

Deprecated. Implement the TypeService as own property

catalogService

protected CatalogService catalogService

Constructor Detail

DefaultCMSComponentService

public DefaultCMSComponentService()

Constructor used to create new instance of DefaultCMSComponentService

Method Detail

getAbstractCMSComponent

public AbstractCMSComponentModel getAbstractCMSComponent(String id)
                                                  throws CMSItemNotFoundException

Gets the abstract cms component.

Specified by:

getAbstractCMSComponent in interface CMSComponentService

Parameters:

id - the id of cms component to get

Returns:

the abstract cms component

Throws:

CMSItemNotFoundException - thrown when item was not found

getAbstractCMSComponent

public <T extends AbstractCMSComponentModel> T getAbstractCMSComponent(String id,
                                                                       Collection<CatalogVersionModel> catalogVersions)
                                                                throws CMSItemNotFoundException

Gets the abstract cms component.

Specified by:

getAbstractCMSComponent in interface CMSComponentService

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

public <T extends AbstractCMSComponentModel> T getAbstractCMSComponent(String id,
                                                                       String contentSlotId,
                                                                       Collection<CatalogVersionModel> catalogVersions)
                                                                throws CMSItemNotFoundException

Gets the abstract cms component.

Specified by:

getAbstractCMSComponent in interface CMSComponentService

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

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

Specified by:

getEditorProperties in interface CMSComponentService

Parameters:

component - the component which editor properties should be retrieved

Returns:

all editor properties

getSimpleCMSComponent

public SimpleCMSComponentModel getSimpleCMSComponent(String id)
                                              throws CMSItemNotFoundException

Gets the simple cms component.

Specified by:

getSimpleCMSComponent in interface CMSComponentService

Parameters:

id - the id of component to get

Returns:

the simple cms component

Throws:

CMSItemNotFoundException - thrown when item was not found

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 CMSComponentService

Parameters:

component - the component which system properties should be retrieved

Returns:

collection of all system properties for component

isCmsComponentRestricted

@Deprecated
public Boolean isCmsComponentRestricted(AbstractCMSComponentModel component)

Deprecated. use isComponentRestricted(AbstractCMSComponentModel) instead.

Checks if passed as parameter AbstractCMSComponentModel is restricted restricted.

Specified by:

isCmsComponentRestricted in interface CMSComponentService

Parameters:

component - the component which is checked against any restrictions

Returns:

Boolean.TRUE if is restricted, Boolean.FALSE otherwise

isComponentContainer

public boolean isComponentContainer(String componentTypeCode)

Description copied from interface: CMSComponentService

Checks if component is a container.

Specified by:

isComponentContainer in interface CMSComponentService

Parameters:

componentTypeCode - the component's ComposedType code

Returns:

Boolean.TRUE if is component, Boolean.FALSE otherwise

isComponentRestricted

public boolean isComponentRestricted(AbstractCMSComponentModel component)

Description copied from interface: CMSComponentService

Checks if passed as parameter AbstractCMSComponentModel is restricted restricted.

Specified by:

isComponentRestricted in interface CMSComponentService

Parameters:

component - the component which is checked against any restrictions

Returns:

true if is restricted, false otherwise

isContainer

@Deprecated
public Boolean isContainer(String componentTypeCode)

Deprecated. use isComponentContainer(String) instead.

Checks if component is a container.

Specified by:

isContainer in interface CMSComponentService

Parameters:

componentTypeCode - the component's ComposedType code

Returns:

Boolean.TRUE if is component, Boolean.FALSE otherwise

setCatalogService

public void setCatalogService(CatalogService catalogService)

setCmsComponentDao

public void setCmsComponentDao(CMSComponentDao cmsComponentDao)

setSystemProperties

public void setSystemProperties(List systemProperties)

setTypeService

public void setTypeService(TypeService typeService)