Package 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, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

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

Method Summary

Modifier and Type	Method	Description
String	getAvailableContentSlotsNames(AbstractPageModel page)	Gets the available content slots names and return them as semicolon separated string ("foo; bar; baz").
protected CatalogVersionService	getCatalogVersionService()
protected CMSContentSlotDao	getCmsContentSlotDao()
protected CMSDataFactory	getCmsDataFactory()
protected CMSPageService	getCmsPageService()
CMSRestrictionService	getCmsRestrictionService()
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, javax.servlet.http.HttpServletRequest httpRequest)	Retrieves a list of components that are valid for particular content slot
boolean	isSharedSlot(ContentSlotModel contentSlot)	Check a content slot is shared or not.
protected RestrictionData	populate(javax.servlet.http.HttpServletRequest request)	Wrapped all information fetched from current HTTP request
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
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, writeReplace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultCMSContentSlotService

public DefaultCMSContentSlotService()

Method Details

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.

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,
 javax.servlet.http.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)

isSharedSlot

public boolean isSharedSlot(ContentSlotModel contentSlot)

Description copied from interface: CMSContentSlotService

Check a content slot is shared or not. A slot is related to a page template or a slot is related multi-pages

Specified by:

isSharedSlot in interface CMSContentSlotService

Parameters:

contentSlot - the ContentSlotModel

Returns:

boolean

populate

protected RestrictionData populate(javax.servlet.http.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

getCmsContentSlotDao

protected CMSContentSlotDao getCmsContentSlotDao()

setCmsContentSlotDao

public void setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)

getCmsDataFactory

protected CMSDataFactory getCmsDataFactory()

setCmsDataFactory

public void setCmsDataFactory(CMSDataFactory cmsDataFactory)

getCatalogVersionService

protected CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getCmsPageService

protected CMSPageService getCmsPageService()

setCmsPageService

public void setCmsPageService(CMSPageService cmsPageService)

getCmsRestrictionService

public CMSRestrictionService getCmsRestrictionService()

setCmsRestrictionService

public void setCmsRestrictionService(CMSRestrictionService cmsRestrictionService)