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

Class DefaultCMSContentSlotService

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

All Implemented Interfaces:

CMSContentSlotService, Serializable

public class DefaultCMSContentSlotService
extends AbstractCMSService
implements CMSContentSlotService

Default implementation of CMSContentSlotService

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 CMSContentSlotDao	cmsContentSlotDao Deprecated. Implement the CMSContentSlotDao as own property
protected CMSDataFactory	cmsDataFactory Deprecated. Implement the CMSDataFactory as own property
protected CMSRestrictionService	cmsRestrictionService

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
DefaultCMSContentSlotService()

Method Summary

Modifier and Type	Method and Description
String	getAvailableContentSlotsNames(AbstractPageModel page) Gets the available content slots names and return them as semicolon separated string ("foo; bar; baz").
CMSRestrictionService	getCmsRestrictionService()
ContentSlotModel	getContentSlot(String id) Deprecated. use getContentSlotForId(String) instead.
ContentSlotModel	getContentSlotForId(String id) Gets the content slot for given id.
List<String>	getDefinedContentSlotPositions(AbstractPageModel page) Gets the defined content slot positions.
List<String>	getDefinedContentSlotPositions(PageTemplateModel pageTemplate) Gets the defined content slot positions.
String	getMissingContentSlotsNames(AbstractPageModel page) Gets the missing content slots names and return them as semicolon separated string ("foo; bar; baz").
Collection<AbstractPageModel>	getPagesForContentSlot(ContentSlotModel contentSlot) Gets the related AbstractPageModel objects for content slot.
List<SimpleCMSComponentModel>	getSimpleCMSComponents(ContentSlotModel contentSlot, boolean previewEnabled, HttpServletRequest httpRequest) Retrieves a list of components that are valid for particular content slot Note: Filters components that are assigned to given content slot according to their restrictions.
protected RestrictionData	populate(HttpServletRequest request) Wrapped all information fetched from current HTTP request
void	setCatalogService(CatalogService catalogService)
void	setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)
void	setCmsDataFactory(CMSDataFactory cmsDataFactory)
void	setCmsPageService(CMSPageService cmsPageService)
void	setCmsRestrictionService(CMSRestrictionService cmsRestrictionService)

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

cmsContentSlotDao

@Deprecated
protected CMSContentSlotDao cmsContentSlotDao

Deprecated. Implement the CMSContentSlotDao as own property

cmsDataFactory

@Deprecated
protected CMSDataFactory cmsDataFactory

Deprecated. Implement the CMSDataFactory as own property

catalogService

protected CatalogService catalogService

cmsRestrictionService

protected CMSRestrictionService cmsRestrictionService

Constructor Detail

DefaultCMSContentSlotService

public DefaultCMSContentSlotService()

Method Detail

getAvailableContentSlotsNames

public String getAvailableContentSlotsNames(AbstractPageModel page)

Gets the available content slots names and return them as semicolon separated string ("foo; bar; baz").

Specified by:

getAvailableContentSlotsNames in interface CMSContentSlotService

Parameters:

page - the AbstractPageModel object. *

Returns:

the available content slots names as semicolon separated string.

getCmsRestrictionService

public CMSRestrictionService getCmsRestrictionService()

getContentSlot

@Deprecated
public ContentSlotModel getContentSlot(String id)
                                            throws CMSItemNotFoundException

Deprecated. use getContentSlotForId(String) instead.

Gets the content slot.

Specified by:

getContentSlot in interface CMSContentSlotService

Parameters:

id - the id of content slot to find

Returns:

the content slot

Throws:

CMSItemNotFoundException - thrown when item was not found

getDefinedContentSlotPositions

public List<String> getDefinedContentSlotPositions(AbstractPageModel page)

Gets the defined content slot positions.

Specified by:

getDefinedContentSlotPositions in interface CMSContentSlotService

Parameters:

page - the page

Returns:

the defined content slot positions

getDefinedContentSlotPositions

public List<String> getDefinedContentSlotPositions(PageTemplateModel pageTemplate)

Gets the defined content slot positions.

Specified by:

getDefinedContentSlotPositions in interface CMSContentSlotService

Parameters:

pageTemplate - the page template

Returns:

the defined content slot positions

getMissingContentSlotsNames

public String getMissingContentSlotsNames(AbstractPageModel page)

Gets the missing content slots names and return them as semicolon separated string ("foo; bar; baz").

Specified by:

getMissingContentSlotsNames in interface CMSContentSlotService

Parameters:

page - the AbstractPageModel object.

Returns:

the missing content slots names.

getPagesForContentSlot

public Collection<AbstractPageModel> getPagesForContentSlot(ContentSlotModel contentSlot)

Gets the related AbstractPageModel objects for content slot.

Specified by:

getPagesForContentSlot in interface CMSContentSlotService

Parameters:

contentSlot - the ContentSlotModel object for which pages will be obtained.

Returns:

the collection of AbstractPageModel objects related to ContentSlotModel object.

getSimpleCMSComponents

public List<SimpleCMSComponentModel> getSimpleCMSComponents(ContentSlotModel contentSlot,
                                                            boolean previewEnabled,
                                                            HttpServletRequest httpRequest)

Retrieves a list of components that are valid for particular content slot

Note: Filters components that are assigned to given content slot according to their restrictions. For more information please see

Specified by:

getSimpleCMSComponents in interface CMSContentSlotService

Parameters:

contentSlot - given content slot

previewEnabled - flag that indicates whether preview is enabled

httpRequest - current HTTP request

Returns:

valid components

See Also:

CMSRestrictionService.evaluateCMSComponent(de.hybris.platform.cms2.model.contents.components.AbstractCMSComponentModel, de.hybris.platform.cms2.servicelayer.data.RestrictionData)

setCatalogService

public void setCatalogService(CatalogService catalogService)

setCmsContentSlotDao

public void setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)

setCmsDataFactory

public void setCmsDataFactory(CMSDataFactory cmsDataFactory)

setCmsPageService

public void setCmsPageService(CMSPageService cmsPageService)

setCmsRestrictionService

public void setCmsRestrictionService(CMSRestrictionService cmsRestrictionService)

populate

protected RestrictionData populate(HttpServletRequest request)

Wrapped all information fetched from current HTTP request

Parameters:

request - current HTTP request

Returns:

all gather information wrapped to RestrictionData object

getContentSlotForId

public ContentSlotModel getContentSlotForId(String id)
                                     throws AmbiguousIdentifierException,
                                            UnknownIdentifierException

Description copied from interface: CMSContentSlotService

Gets the content slot for given id.

Specified by:

getContentSlotForId in interface CMSContentSlotService

Parameters:

id - the id of content slot to find

Returns:

found content slot

Throws:

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

UnknownIdentifierException - thrown when no object has been found