Package de.hybris.platform.cmsfacades.pagescontentslotscomponents.impl

Class DefaultPageContentSlotComponentFacade

java.lang.Object

de.hybris.platform.cmsfacades.pagescontentslotscomponents.impl.DefaultPageContentSlotComponentFacade

All Implemented Interfaces:

PageContentSlotComponentFacade

public class DefaultPageContentSlotComponentFacade
extends Object
implements PageContentSlotComponentFacade

Default implementation of PageContentSlotComponentFacade. This implementation will expect that a catalog version has been placed into a local session.

Constructor Summary

Constructors

Constructor	Description
DefaultPageContentSlotComponentFacade()

Method Summary

Modifier and Type	Method	Description
PageContentSlotComponentData	addComponentToContentSlot(PageContentSlotComponentData pageContentSlotComponent)	Add an existing component item into a specific index position of an existing content slot.
protected PageContentSlotComponentData	buildPageContentSlotComponent(String pageId, String slotId, Integer position, AbstractCMSComponentModel component)	Build a single PageContentSlotComponentData.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultPageContentSlotComponentFacade

public DefaultPageContentSlotComponentFacade()

Method Details

getPageContentSlotComponentsByPageId

public List<PageContentSlotComponentData> getPageContentSlotComponentsByPageId(String pageId)
                                                                        throws CMSItemNotFoundException

Description copied from interface: PageContentSlotComponentFacade

Get a list of content slot with their components and their position in the slots for a given page.

Specified by:

getPageContentSlotComponentsByPageId in interface PageContentSlotComponentFacade

Parameters:

pageId - - the page for which to look up the content slots for

Returns:

list of content slot ids with the component ids in each slot; never null

Throws:

CMSItemNotFoundException - when the page cannot be found

buildPageContentSlotComponentStream

protected Stream<PageContentSlotComponentData> buildPageContentSlotComponentStream(String pageId,
 ContentSlotData contentSlot)

Build a stream of PageContentSlotComponentData.

Parameters:

pageId - - the page id

contentSlot - - the content slot

Returns:

a new stream of DTOs

buildPageContentSlotComponent

protected PageContentSlotComponentData buildPageContentSlotComponent(String pageId,
 String slotId,
 Integer position,
 AbstractCMSComponentModel component)

Build a single PageContentSlotComponentData.

Parameters:

pageId - - the page id

slotId - - the slot id

position - - the position of the component in the slot

component - - the CMS component model

Returns:

a new DTO

addComponentToContentSlot

@Transactional
public PageContentSlotComponentData addComponentToContentSlot(PageContentSlotComponentData pageContentSlotComponent)
                                                       throws CMSItemNotFoundException

Description copied from interface: PageContentSlotComponentFacade

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

If the index provided is larger than or equal to the next available component index in the slot, then the component will be added into the next available index.

Specified by:

addComponentToContentSlot in interface PageContentSlotComponentFacade

Parameters:

pageContentSlotComponent - - DTO holding required attributes; never null

Returns:

the pageContentSlotComponent holding the componentId added to the slot and the pageId, slotId and slot position of the targeted content slot.

Throws:

CMSItemNotFoundException - when the component or slot cannot be found

removeComponentFromContentSlot

public void removeComponentFromContentSlot(String slotId,
 String componentId)
                                    throws CMSItemNotFoundException

Description copied from interface: PageContentSlotComponentFacade

Remove a component item from a content slot.

Specified by:

removeComponentFromContentSlot in interface PageContentSlotComponentFacade

Parameters:

slotId - - the unique identifier of the content slot; never null

componentId - - the unique identifier of the component item; never null

Throws:

CMSItemNotFoundException - when the component or slot cannot be found

moveComponent

public PageContentSlotComponentData moveComponent(String pageUid,
 String componentUid,
 String originSlotUid,
 PageContentSlotComponentData pageContentSlotComponentData)
                                           throws CMSItemNotFoundException

Description copied from interface: PageContentSlotComponentFacade

Moves a component within a slot or between slots.

Specified by:

moveComponent in interface PageContentSlotComponentFacade

Parameters:

pageUid - Page UID

componentUid - UID of the component to move

originSlotUid - The UID of the content slot that contains the origin content slot

pageContentSlotComponentData - PageContentSlotComponentData The component which contains all information of it's final destination

Returns:

the pageContentSlotComponent holding the componentId moved to the slot and the pageId, slotId and slot position of the targeted content slot.

Throws:

CMSItemNotFoundException - when the component or slot cannot be found

fetchComponent

protected AbstractCMSComponentModel fetchComponent(String componentId)
                                            throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

fetchContentSlot

protected ContentSlotModel fetchContentSlot(String slotId)
                                     throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

buildPageContentSlotComponentValidationDto

protected PageContentSlotComponentData buildPageContentSlotComponentValidationDto(String slotId,
 PageContentSlotComponentData pageContentSlotComponentData)

Build a new DTO for validating adding existing component to content slot.

Parameters:

slotId -

pageContentSlotComponentData -

Returns:

the new DTO

createTypePermissionException

protected TypePermissionException createTypePermissionException(String permissionName,
 String itemType)

Creates a new TypePermissionException with a localized error message

Parameters:

permissionName - The permission name defined by PermissionsConstants

itemType - The type code of the item

Returns:

a new TypePermissionException

getAdminPageService

protected CMSAdminPageService getAdminPageService()

setAdminPageService

public void setAdminPageService(CMSAdminPageService adminPageService)

getAdminContentSlotService

protected CMSAdminContentSlotService getAdminContentSlotService()

setAdminContentSlotService

public void setAdminContentSlotService(CMSAdminContentSlotService adminContentSlotService)

getAdminComponentService

protected CMSAdminComponentService getAdminComponentService()

setAdminComponentService

public void setAdminComponentService(CMSAdminComponentService adminComponentService)

getCreatePageContentSlotComponentCompositeValidator

protected org.springframework.validation.Validator getCreatePageContentSlotComponentCompositeValidator()

setCreatePageContentSlotComponentCompositeValidator

public void setCreatePageContentSlotComponentCompositeValidator(org.springframework.validation.Validator createPageContentSlotComponentCompositeValidator)

getFacadeValidationService

protected FacadeValidationService getFacadeValidationService()

setFacadeValidationService

public void setFacadeValidationService(FacadeValidationService facadeValidationService)

getUpdatePageContentSlotComponentValidator

protected org.springframework.validation.Validator getUpdatePageContentSlotComponentValidator()

setUpdatePageContentSlotComponentValidator

public void setUpdatePageContentSlotComponentValidator(org.springframework.validation.Validator updatePageContentSlotComponentValidator)

getTransactionManager

public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

getComponentExistsInSlotValidator

public org.springframework.validation.Validator getComponentExistsInSlotValidator()

setComponentExistsInSlotValidator

public void setComponentExistsInSlotValidator(org.springframework.validation.Validator componentExistsInSlotValidator)

getUniqueItemIdentifierService

protected UniqueItemIdentifierService getUniqueItemIdentifierService()

setUniqueItemIdentifierService

public void setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)

getCatalogVersionService

protected CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getSessionSearchRestrictionsDisabler

protected SessionSearchRestrictionsDisabler getSessionSearchRestrictionsDisabler()

setSessionSearchRestrictionsDisabler

public void setSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler)

getPermissionCRUDService

protected PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)