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

Class DefaultCMSAdminContentSlotService

java.lang.Object

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

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

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

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

All Implemented Interfaces:

CMSAdminContentSlotService, java.io.Serializable

public class DefaultCMSAdminContentSlotService
extends AbstractCMSAdminService
implements CMSAdminContentSlotService

Default implementation of the content slot service.

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
static java.lang.String	DEFAULT_CONTENTSLOT_FOR_PAGE_UID_PREFIX
static java.lang.String	DEFAULT_CONTENTSLOT_UID_SUFFIX

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

ACTIVECATALOGVERSION, ACTIVESITE, CLONE_CONTEXT, RESTORE_CONTEXT

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

Method Summary

Modifier and Type	Method and Description
void	addCMSComponentToContentSlot(AbstractCMSComponentModel component, ContentSlotModel slot, java.lang.Integer index) Add an existing component item into a specific index position of an existing content slot.
protected void	addComponentToComponentListSaveAsSlot(AbstractCMSComponentModel component, ContentSlotModel slot, java.lang.Integer index, java.util.List<AbstractCMSComponentModel> currentComponentList)
protected java.util.List<ContentSlotModel>	appendTemplateSlots(PageTemplateModel pageTemplate, java.util.Set<java.lang.String> positions, java.util.List<ContentSlotData> contentSlots, AbstractPageModel page) Gets all of the content slots for templates that do not share a position already identified in the content slots for pages.
ContentSlotModel	createContentSlot(AbstractPageModel page, java.lang.String id, java.lang.String name, java.lang.String position) Creates the ContentSlotModel object and ContentSlotForPageModel relation.
ContentSlotModel	createContentSlot(AbstractPageModel page, java.lang.String id, java.lang.String name, java.lang.String position, boolean active) Creates the ContentSlotModel object and ContentSlotForPageModel relation.
ContentSlotModel	createContentSlot(AbstractPageModel page, java.lang.String id, java.lang.String name, java.lang.String position, boolean active, java.util.Date activeFrom, java.util.Date activeUntil) Creates the ContentSlotModel object and ContentSlotForPageModel relation.
void	deleteContentSlot(java.lang.String contentSlotId) delete a content slot and ALL PAGE RELATIONS to it.
void	deleteRelation(AbstractPageModel page, ContentSlotModel contentSlot) delete the relation between a content slot and a page
void	deleteRelationByPosition(AbstractPageModel page, java.lang.String position) deletes a relation between a page and a content slot.
java.util.List<ContentSlotForPageModel>	findAllContentSlotRelationsByPage(AbstractPageModel page) Find all content slot relations by page.
java.util.List<ContentSlotForTemplateModel>	findAllContentSlotRelationsByPageTemplate(PageTemplateModel template) Find all content slot relations by page template.
protected java.lang.String	generateContentSlotForPageUID() Generate the content slot id using the page uid prefix and the key generator.
protected java.lang.String	generateContentSlotUid(AbstractPageModel page, java.lang.String position) Generate the Content Slot Uid after the slot position and page Uid
protected CMSAdminSiteService	getAdminSiteService()
java.util.Collection<CMSRelationModel>	getAllRelationsForSlot(ContentSlotModel contentSlot) Returns all page and template relations with references to this content slot
protected CMSAdminComponentService	getCmsAdminComponentService()
protected CatalogLevelService	getCmsCatalogLevelService()
protected CMSContentSlotDao	getCmsContentSlotDao()
protected CMSDataFactory	getCmsDataFactory()
protected ConfigurationService	getConfigurationService()
ContentSlotModel	getContentSlotForId(java.lang.String contentSlotId) Gets the content slot for specific content slot id.
ContentSlotModel	getContentSlotForIdAndCatalogVersions(java.lang.String contentSlotId, java.util.Collection<CatalogVersionModel> catalogVersions) Gets the content slot for slot id and collection of catalog versions.
java.lang.String	getContentSlotForPageUidPrefix()
ContentSlotModel	getContentSlotOverride(AbstractPageModel page, ContentSlotModel contentSlot) Find the content slot in the catalog hierarchy (used with multi-country)
java.lang.String	getContentSlotPosition(AbstractPageModel page, ContentSlotModel contentSlot) Find the position of the content slot on the page or its associated page template
java.util.List<ContentSlotForPageModel>	getContentSlotRelationsByPageId(java.lang.String pageId, CatalogVersionModel catalogVersion) Find content slot relations for a given pageId and catalog version.
java.util.Collection<ContentSlotModel>	getContentSlotsForCatalogVersion(CatalogVersionModel catalogVersion) Find all content slots that belong to a given catalog version.
java.util.Collection<ContentSlotData>	getContentSlotsForPage(AbstractPageModel page) returns a collection of all content slots for the given page.
java.util.Collection<ContentSlotData>	getContentSlotsForPage(AbstractPageModel page, boolean includeMasterTemplateSlots) Returns a collection of all content slots for the given page.
java.lang.String	getContentSlotUidSuffix()
KeyGenerator	getKeyGenerator()
java.util.Collection<CMSRelationModel>	getOnlyContentSlotRelationsForSlot(ContentSlotModel contentSlot) Returns only page relations with references to this content slot.
protected ContentSlotModel	getOverrideSlot(java.util.List<ContentSlotModel> contentSlots, ContentSlotModel contentSlot)
protected PermissionCRUDService	getPermissionCRUDService()
java.util.List<ContentSlotModel>	getSortedMultiCountryContentSlots(java.util.List<ContentSlotModel> contentSlots, java.util.List<CatalogVersionModel> catalogVersions) Orders the given content slots according to the catalog level where the slots are defined.
boolean	hasOtherRelations(AbstractPageModel page, ContentSlotModel contentSlot) Checks if there are other relations between the given content slot and other pages (except the given one)
boolean	hasRelations(ContentSlotModel contentSlot) Checks if the given content slot has relations to one or more pages
void	setAdminSiteService(CMSAdminSiteService adminSiteService)
void	setCmsAdminComponentService(CMSAdminComponentService cmsAdminComponentService)
void	setCmsCatalogLevelService(CatalogLevelService cmsCatalogLevelService)
void	setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)
void	setCmsDataFactory(CMSDataFactory cmsDataFactory)
void	setConfigurationService(ConfigurationService configurationService)
void	setContentSlotForPageUidPrefix(java.lang.String contentSlotForPageUidPrefix)
void	setContentSlotUidSuffix(java.lang.String contentSlotUidSuffix)
void	setKeyGenerator(KeyGenerator keyGenerator)
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)
protected void	throwTypePermissionException(java.lang.String permissionName, java.lang.String typeCode) Throws TypePermissionException.
void	updatePositionCMSComponentInContentSlot(AbstractCMSComponentModel component, ContentSlotModel slot, java.lang.Integer index) Update the position of an existing component item into a specific index position of an existing content slot.

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

getActiveCatalogVersion, getActiveSite, getBaseSiteService, getUserService, setBaseSiteService, 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

Field Detail

DEFAULT_CONTENTSLOT_FOR_PAGE_UID_PREFIX

public static final java.lang.String DEFAULT_CONTENTSLOT_FOR_PAGE_UID_PREFIX

See Also:

Constant Field Values

DEFAULT_CONTENTSLOT_UID_SUFFIX

public static final java.lang.String DEFAULT_CONTENTSLOT_UID_SUFFIX

See Also:

Constant Field Values

Constructor Detail

DefaultCMSAdminContentSlotService

public DefaultCMSAdminContentSlotService()

Method Detail

createContentSlot

public ContentSlotModel createContentSlot(AbstractPageModel page,
                                          java.lang.String id,
                                          java.lang.String name,
                                          java.lang.String position)

Creates the ContentSlotModel object and ContentSlotForPageModel relation. Method explicitly saves both objects.

Specified by:

createContentSlot in interface CMSAdminContentSlotService

Parameters:

page - the page which will be set for ContentSlotForPageModel relation.

id - the id of content slot.

name - the name of content slot.

position - the position of page.

Returns:

the ContentSlotModel object.

createContentSlot

public ContentSlotModel createContentSlot(AbstractPageModel page,
                                          java.lang.String id,
                                          java.lang.String name,
                                          java.lang.String position,
                                          boolean active)

Creates the ContentSlotModel object and ContentSlotForPageModel relation. Method explicitly saves both objects.

Specified by:

createContentSlot in interface CMSAdminContentSlotService

Parameters:

page - the page which will be set for ContentSlotForPageModel relation.

id - the id of content slot.

name - the name of content slot.

position - the position of page.

active - the activity of content slot (true or false)

Returns:

the ContentSlotModel object.

createContentSlot

public ContentSlotModel createContentSlot(AbstractPageModel page,
                                          java.lang.String id,
                                          java.lang.String name,
                                          java.lang.String position,
                                          boolean active,
                                          java.util.Date activeFrom,
                                          java.util.Date activeUntil)

Creates the ContentSlotModel object and ContentSlotForPageModel relation. Method explicitly saves both objects.

Specified by:

createContentSlot in interface CMSAdminContentSlotService

Parameters:

page - the page which will be set for ContentSlotForPageModel relation.

id - the id of content slot.

name - the name of content slot.

position - the position of page.

active - the activity of content slot (true or false)

activeFrom - start date of activity.

activeUntil - end date of activity.

Returns:

the ContentSlotModel object.

generateContentSlotUid

protected java.lang.String generateContentSlotUid(AbstractPageModel page,
                                                  java.lang.String position)

Generate the Content Slot Uid after the slot position and page Uid

Parameters:

page - page model to get the uid from

position - the position on the slot

Returns:

the content slot uid

generateContentSlotForPageUID

protected java.lang.String generateContentSlotForPageUID()

Generate the content slot id using the page uid prefix and the key generator.

Returns:

a content slot uid

deleteContentSlot

public void deleteContentSlot(java.lang.String contentSlotId)
                       throws CMSItemNotFoundException

delete a content slot and ALL PAGE RELATIONS to it.

Specified by:

deleteContentSlot in interface CMSAdminContentSlotService

Parameters:

contentSlotId - the identifier of the content slot to be deleted

Throws:

CMSItemNotFoundException - if the content slot could not be found

deleteRelation

public void deleteRelation(AbstractPageModel page,
                           ContentSlotModel contentSlot)

delete the relation between a content slot and a page

Specified by:

deleteRelation in interface CMSAdminContentSlotService

Parameters:

page - the page model

contentSlot - the content slot model

deleteRelationByPosition

public void deleteRelationByPosition(AbstractPageModel page,
                                     java.lang.String position)

deletes a relation between a page and a content slot. The content slot will be identified via the position

Specified by:

deleteRelationByPosition in interface CMSAdminContentSlotService

Parameters:

page - the page model

position - the position

getAllRelationsForSlot

public java.util.Collection<CMSRelationModel> getAllRelationsForSlot(ContentSlotModel contentSlot)

Returns all page and template relations with references to this content slot

Specified by:

getAllRelationsForSlot in interface CMSAdminContentSlotService

Parameters:

contentSlot - the content slot

Returns:

the collection of relations

getOnlyContentSlotRelationsForSlot

public java.util.Collection<CMSRelationModel> getOnlyContentSlotRelationsForSlot(ContentSlotModel contentSlot)

Returns only page relations with references to this content slot. Unlike CMSAdminContentSlotService.getAllRelationsForSlot(ContentSlotModel) it does not return template relations

Specified by:

getOnlyContentSlotRelationsForSlot in interface CMSAdminContentSlotService

Parameters:

contentSlot - the content slot

Returns:

the collection of relations

See Also:

CMSAdminContentSlotService.getAllRelationsForSlot(ContentSlotModel)

getContentSlotForId

public ContentSlotModel getContentSlotForId(java.lang.String contentSlotId)
                                     throws UnknownIdentifierException,
                                            AmbiguousIdentifierException

Gets the content slot for specific content slot id.

Specified by:

getContentSlotForId in interface CMSAdminContentSlotService

Parameters:

contentSlotId - the content slot id

Returns:

found content slot object.

Throws:

UnknownIdentifierException - thrown when no object has been found

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

getContentSlotForIdAndCatalogVersions

public ContentSlotModel getContentSlotForIdAndCatalogVersions(java.lang.String contentSlotId,
                                                              java.util.Collection<CatalogVersionModel> catalogVersions)
                                                       throws UnknownIdentifierException,
                                                              AmbiguousIdentifierException

Gets the content slot for slot id and collection of catalog versions.

Specified by:

getContentSlotForIdAndCatalogVersions in interface CMSAdminContentSlotService

Parameters:

contentSlotId - the content slot id

catalogVersions - the collection of catalog versions

Returns:

the content slot for slot id and catalog versions

Throws:

UnknownIdentifierException - thrown when no object has been found

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

getContentSlotsForPage

public java.util.Collection<ContentSlotData> getContentSlotsForPage(AbstractPageModel page)

returns a collection of all content slots for the given page. This also includes content slots which are defined in the master template. If on a certain position a content slot is defined in the master and page, it will return the content slot from the page

Specified by:

getContentSlotsForPage in interface CMSAdminContentSlotService

Parameters:

page - the page model

Returns:

all content slots for a given page

getContentSlotsForPage

public java.util.Collection<ContentSlotData> getContentSlotsForPage(AbstractPageModel page,
                                                                    boolean includeMasterTemplateSlots)

Returns a collection of all content slots for the given page. If desired, the collection will include the content slots which are defined in the master template. If on a certain position a content slot is defined in the master and page, it will return the content slot from the page.

Specified by:

getContentSlotsForPage in interface CMSAdminContentSlotService

Parameters:

page - the page for which to retrieve the content slots

includeMasterTemplateSlots - true to include the content slots defined in the master page template, false otherwise

Returns:

all content slots for a given page

findAllContentSlotRelationsByPageTemplate

public java.util.List<ContentSlotForTemplateModel> findAllContentSlotRelationsByPageTemplate(PageTemplateModel template)

Find all content slot relations by page template.

Specified by:

findAllContentSlotRelationsByPageTemplate in interface CMSAdminContentSlotService

Parameters:

template - the page template

Returns:

the list of found ContentSlotForTemplateModel objects or empty list when not found.

findAllContentSlotRelationsByPage

public java.util.List<ContentSlotForPageModel> findAllContentSlotRelationsByPage(AbstractPageModel page)

Find all content slot relations by page.

Specified by:

findAllContentSlotRelationsByPage in interface CMSAdminContentSlotService

Parameters:

page - the page

Returns:

the list of found ContentSlotForPageModel objects or empty list when not found

getOverrideSlot

protected ContentSlotModel getOverrideSlot(java.util.List<ContentSlotModel> contentSlots,
                                           ContentSlotModel contentSlot)

appendTemplateSlots

protected java.util.List<ContentSlotModel> appendTemplateSlots(PageTemplateModel pageTemplate,
                                                               java.util.Set<java.lang.String> positions,
                                                               java.util.List<ContentSlotData> contentSlots,
                                                               AbstractPageModel page)

Gets all of the content slots for templates that do not share a position already identified in the content slots for pages. Also, if a page content slot's position matches with that of a slot for a template then mark the page slot as override.

Parameters:

pageTemplate - - the page template

positions - - the positions

contentSlots - - the list of content slot which new slots values will be appended to

page - - the page containing the content slot

Returns:

list of template slots appended to the contentSlots list

updatePositionCMSComponentInContentSlot

public void updatePositionCMSComponentInContentSlot(AbstractCMSComponentModel component,
                                                    ContentSlotModel slot,
                                                    java.lang.Integer index)

Description copied from interface: CMSAdminContentSlotService

Update the position of an existing component item into a specific index position of an existing content slot.

If the index provided is larger than the last available position in the slot, then the component will be added to the last position.

Specified by:

updatePositionCMSComponentInContentSlot in interface CMSAdminContentSlotService

Parameters:

component - - the component item; never null

slot - - the content slot; never null

index - - where to insert the component in the slot; never null, must be a positive number

addCMSComponentToContentSlot

public void addCMSComponentToContentSlot(AbstractCMSComponentModel component,
                                         ContentSlotModel slot,
                                         java.lang.Integer index)

Description copied from interface: CMSAdminContentSlotService

Add an existing component item into a specific index position of an existing content slot.

If the index provided is larger than the last available position in the slot, then the component will be added to the last position.

Specified by:

addCMSComponentToContentSlot in interface CMSAdminContentSlotService

Parameters:

component - - the component item; never null

slot - - the content slot; never null

index - - where to insert the component in the slot; never null, must be a positive number

addComponentToComponentListSaveAsSlot

protected void addComponentToComponentListSaveAsSlot(AbstractCMSComponentModel component,
                                                     ContentSlotModel slot,
                                                     java.lang.Integer index,
                                                     java.util.List<AbstractCMSComponentModel> currentComponentList)

hasOtherRelations

public boolean hasOtherRelations(AbstractPageModel page,
                                 ContentSlotModel contentSlot)

Checks if there are other relations between the given content slot and other pages (except the given one)

Specified by:

hasOtherRelations in interface CMSAdminContentSlotService

Parameters:

page - the page model

contentSlot - the content slot model

Returns:

true if there are other relations between the content slot and other pages; false otherwise

hasRelations

public boolean hasRelations(ContentSlotModel contentSlot)

Checks if the given content slot has relations to one or more pages

Specified by:

hasRelations in interface CMSAdminContentSlotService

Parameters:

contentSlot - the content slot model

Returns:

true if there are relations to at least one other page; false otherwise

getContentSlotsForCatalogVersion

public java.util.Collection<ContentSlotModel> getContentSlotsForCatalogVersion(CatalogVersionModel catalogVersion)

Description copied from interface: CMSAdminContentSlotService

Find all content slots that belong to a given catalog version.

Specified by:

getContentSlotsForCatalogVersion in interface CMSAdminContentSlotService

Parameters:

catalogVersion - - the catalog version

Returns:

collection of content slots; never null

getSortedMultiCountryContentSlots

public java.util.List<ContentSlotModel> getSortedMultiCountryContentSlots(java.util.List<ContentSlotModel> contentSlots,
                                                                          java.util.List<CatalogVersionModel> catalogVersions)

Description copied from interface: CMSAdminContentSlotService

Orders the given content slots according to the catalog level where the slots are defined. This uses the CatalogLevelService to determine the ordering.

Specified by:

getSortedMultiCountryContentSlots in interface CMSAdminContentSlotService

Parameters:

contentSlots - - the content slots to be sorted

catalogVersions - - the catalog versions

Returns:

a sorted list of content slots

getContentSlotOverride

public ContentSlotModel getContentSlotOverride(AbstractPageModel page,
                                               ContentSlotModel contentSlot)

Description copied from interface: CMSAdminContentSlotService

Find the content slot in the catalog hierarchy (used with multi-country)

Specified by:

getContentSlotOverride in interface CMSAdminContentSlotService

Parameters:

page - - the page model used to determine the target catalog version

contentSlot - - the content slot to be overridden

Returns:

the content slot; can be null

getContentSlotRelationsByPageId

public java.util.List<ContentSlotForPageModel> getContentSlotRelationsByPageId(java.lang.String pageId,
                                                                               CatalogVersionModel catalogVersion)

Description copied from interface: CMSAdminContentSlotService

Find content slot relations for a given pageId and catalog version.

Specified by:

getContentSlotRelationsByPageId in interface CMSAdminContentSlotService

Parameters:

pageId - the page identifier

catalogVersion - the catalog versions

Returns:

the list of found ContentSlotForPageModel objects or empty list when not found

getContentSlotPosition

public java.lang.String getContentSlotPosition(AbstractPageModel page,
                                               ContentSlotModel contentSlot)

Description copied from interface: CMSAdminContentSlotService

Find the position of the content slot on the page or its associated page template

Specified by:

getContentSlotPosition in interface CMSAdminContentSlotService

Parameters:

page - the page model containing the content slot

contentSlot - the content slot to search for

Returns:

the position of the content slot on the page; null if not found

throwTypePermissionException

protected void throwTypePermissionException(java.lang.String permissionName,
                                            java.lang.String typeCode)

Throws TypePermissionException.

Parameters:

permissionName - permission name

typeCode - type code

setCmsAdminComponentService

public void setCmsAdminComponentService(CMSAdminComponentService cmsAdminComponentService)

setCmsContentSlotDao

public void setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)

setCmsDataFactory

public void setCmsDataFactory(CMSDataFactory cmsDataFactory)

getCmsAdminComponentService

protected CMSAdminComponentService getCmsAdminComponentService()

getCmsContentSlotDao

protected CMSContentSlotDao getCmsContentSlotDao()

getCmsDataFactory

protected CMSDataFactory getCmsDataFactory()

getKeyGenerator

public KeyGenerator getKeyGenerator()

setKeyGenerator

public void setKeyGenerator(KeyGenerator keyGenerator)

getAdminSiteService

protected CMSAdminSiteService getAdminSiteService()

setAdminSiteService

public void setAdminSiteService(CMSAdminSiteService adminSiteService)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getCmsCatalogLevelService

protected CatalogLevelService getCmsCatalogLevelService()

setCmsCatalogLevelService

public void setCmsCatalogLevelService(CatalogLevelService cmsCatalogLevelService)

getContentSlotForPageUidPrefix

public java.lang.String getContentSlotForPageUidPrefix()

setContentSlotForPageUidPrefix

public void setContentSlotForPageUidPrefix(java.lang.String contentSlotForPageUidPrefix)

getContentSlotUidSuffix

public java.lang.String getContentSlotUidSuffix()

setContentSlotUidSuffix

public void setContentSlotUidSuffix(java.lang.String contentSlotUidSuffix)

getPermissionCRUDService

protected PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)