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

Interface CMSAdminContentSlotService

All Known Implementing Classes:

DefaultCMSAdminContentSlotService

public interface CMSAdminContentSlotService

The Interface CMSAdminContentSlotService responsible for managing content slots.

Spring Bean ID:

cmsAdminContentSlotService

Method Summary

Modifier and Type	Method and Description
void	addCMSComponentToContentSlot(AbstractCMSComponentModel component, ContentSlotModel slot, Integer index) Add an existing component item into a specific index position of an existing content slot.
ContentSlotModel	createContentSlot(AbstractPageModel page, String id, String name, String position) Creates the ContentSlotModel object and ContentSlotForPageModel relation.
ContentSlotModel	createContentSlot(AbstractPageModel page, String id, String name, String position, boolean active) Creates the ContentSlotModel object and ContentSlotForPageModel relation.
ContentSlotModel	createContentSlot(AbstractPageModel page, String id, String name, String position, boolean active, Date activeFrom, Date activeUntil) Creates the ContentSlotModel object and ContentSlotForPageModel relation.
void	deleteContentSlot(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, String position) deletes a relation between a page and a content slot.
Collection<CMSRelationModel>	getAllRelationsForSlot(ContentSlotModel contentSlot) Returns all page and template relations with references to this content slot
ContentSlotModel	getContentSlot(String contentSlotId) Deprecated. use getContentSlotForId(String) instead.
ContentSlotModel	getContentSlot(String contentSlotId, Collection<CatalogVersionModel> catalogVersions) Deprecated. use getContentSlotForIdAndCatalogVersions(String, Collection) instead.
ContentSlotModel	getContentSlotForId(String contentSlotId) Gets the content slot for specific content slot id.
ContentSlotModel	getContentSlotForIdAndCatalogVersions(String contentSlotId, Collection<CatalogVersionModel> catalogVersions) Gets the content slot for slot id and collection of catalog versions.
Collection<ContentSlotModel>	getContentSlotsForCatalogVersion(CatalogVersionModel catalogVersion) Find all content slots that belong to a given catalog version.
Collection<ContentSlotData>	getContentSlotsForPage(AbstractPageModel page) returns a collection of all content slots for the given page.
Collection<CMSRelationModel>	getOnlyContentSlotRelationsForSlot(ContentSlotModel contentSlot) Returns only page relations with references to this content slot.
Collection<ContentSlotForPageModel>	getPageRelationsForSlot(ContentSlotModel contentSlot) Deprecated. since version 6.3; Please use getContentSlotsForPage(AbstractPageModel) instead to retrieve shared content slot information.
Collection<ContentSlotForTemplateModel>	getTemplateRelationsForSlot(ContentSlotModel contentSlot) Deprecated. since version 6.3; Please use getContentSlotsForPage(AbstractPageModel) instead to retrieve shared content slot information.
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	updatePositionCMSComponentInContentSlot(AbstractCMSComponentModel component, ContentSlotModel slot, Integer index) Update the position of an existing component item into a specific index position of an existing content slot.

Method Detail

createContentSlot

ContentSlotModel createContentSlot(AbstractPageModel page,
                                   String id,
                                   String name,
                                   String position)

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

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

ContentSlotModel createContentSlot(AbstractPageModel page,
                                   String id,
                                   String name,
                                   String position,
                                   boolean active)

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

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

ContentSlotModel createContentSlot(AbstractPageModel page,
                                   String id,
                                   String name,
                                   String position,
                                   boolean active,
                                   Date activeFrom,
                                   Date activeUntil)

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

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.

deleteContentSlot

void deleteContentSlot(String contentSlotId)
                throws CMSItemNotFoundException

delete a content slot and ALL PAGE RELATIONS to it.

Parameters:

contentSlotId - the identifier of the content slot to be deleted

Throws:

CMSItemNotFoundException - if the content slot could not be found

deleteRelation

void deleteRelation(AbstractPageModel page,
                    ContentSlotModel contentSlot)

delete the relation between a content slot and a page

Parameters:

page -

contentSlot -

deleteRelationByPosition

void deleteRelationByPosition(AbstractPageModel page,
                              String position)

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

Parameters:

page -

position -

getAllRelationsForSlot

Collection<CMSRelationModel> getAllRelationsForSlot(ContentSlotModel contentSlot)

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

Parameters:

contentSlot - the content slot

Returns:

the collection of relations

getContentSlot

@Deprecated
ContentSlotModel getContentSlot(String contentSlotId)
                                     throws CMSItemNotFoundException

Deprecated. use getContentSlotForId(String) instead.

Gets the content slot.

Parameters:

contentSlotId - the content slot id

Returns:

the content slot

Throws:

CMSItemNotFoundException - the CMS item not found exception

getContentSlotForId

ContentSlotModel getContentSlotForId(String contentSlotId)
                              throws UnknownIdentifierException,
                                     AmbiguousIdentifierException

Gets the content slot for specific content slot id.

Parameters:

contentSlotId - the content slot id

Returns:

found content slot object.

Throws:

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

UnknownIdentifierException - thrown when no object has been found

getContentSlot

@Deprecated
ContentSlotModel getContentSlot(String contentSlotId,
                                            Collection<CatalogVersionModel> catalogVersions)
                                     throws CMSItemNotFoundException

Deprecated. use getContentSlotForIdAndCatalogVersions(String, Collection) instead.

Gets the content slot.

Parameters:

contentSlotId - the content slot id

catalogVersions - the catalog versions

Returns:

the content slot

Throws:

CMSItemNotFoundException - the CMS item not found exception

getContentSlotForIdAndCatalogVersions

ContentSlotModel getContentSlotForIdAndCatalogVersions(String contentSlotId,
                                                       Collection<CatalogVersionModel> catalogVersions)
                                                throws UnknownIdentifierException,
                                                       AmbiguousIdentifierException

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

Parameters:

contentSlotId - the content slot id

catalogVersions - the collection of catalog versions

Returns:

the content slot for slot id and catalog versions

Throws:

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

UnknownIdentifierException - thrown when no object has been found

getContentSlotsForPage

Collection<ContentSlotData> getContentSlotsForPage(AbstractPageModel page)

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

Parameters:

page -

Returns:

all content slots for a given page

hasOtherRelations

boolean hasOtherRelations(AbstractPageModel page,
                          ContentSlotModel contentSlot)

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

Parameters:

page -

contentSlot -

Returns:

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

hasRelations

boolean hasRelations(ContentSlotModel contentSlot)

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

Parameters:

contentSlot -

Returns:

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

getOnlyContentSlotRelationsForSlot

Collection<CMSRelationModel> getOnlyContentSlotRelationsForSlot(ContentSlotModel contentSlot)

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

Parameters:

contentSlot - the content slot

Returns:

the collection of relations

See Also:

getAllRelationsForSlot(ContentSlotModel)

addCMSComponentToContentSlot

void addCMSComponentToContentSlot(AbstractCMSComponentModel component,
                                  ContentSlotModel slot,
                                  Integer index)

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.

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

updatePositionCMSComponentInContentSlot

void updatePositionCMSComponentInContentSlot(AbstractCMSComponentModel component,
                                             ContentSlotModel slot,
                                             Integer index)

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.

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

getPageRelationsForSlot

@Deprecated
Collection<ContentSlotForPageModel> getPageRelationsForSlot(ContentSlotModel contentSlot)

Deprecated. since version 6.3; Please use getContentSlotsForPage(AbstractPageModel) instead to retrieve shared content slot information.

Find all content slot for page relations for a specific content slot.

Parameters:

contentSlot - the content slot

Returns:

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

getTemplateRelationsForSlot

@Deprecated
Collection<ContentSlotForTemplateModel> getTemplateRelationsForSlot(ContentSlotModel contentSlot)

Deprecated. since version 6.3; Please use getContentSlotsForPage(AbstractPageModel) instead to retrieve shared content slot information.

Find all content slot for template relations for a specific content slot which is not overridden by a page content slot or the page template is not used by any page.

Parameters:

contentSlot - the content slot

Returns:

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

getContentSlotsForCatalogVersion

Collection<ContentSlotModel> getContentSlotsForCatalogVersion(CatalogVersionModel catalogVersion)

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

Parameters:

catalogVersion - - the catalog version

Returns:

collection of content slots; never null