de.hybris.platform.cmsfacades.items.impl

Class DefaultComponentItemFacade

java.lang.Object

de.hybris.platform.cmsfacades.items.impl.DefaultComponentItemFacade

All Implemented Interfaces:

ComponentItemFacade

public class DefaultComponentItemFacade
extends java.lang.Object
implements ComponentItemFacade

Default implementation of ComponentItemFacade.

Constructor Summary

Constructors

Constructor and Description
DefaultComponentItemFacade()

Method Summary

Modifier and Type	Method and Description
AbstractCMSComponentData	addComponentItem(AbstractCMSComponentData component) Adds a new component instance and assigns it to a slot.
protected UpdateComponentValidationDto	buildUpdateComponentValidationDto(java.lang.String originalUid, AbstractCMSComponentData component) Deprecated. since 6.6
protected java.util.function.Supplier<AbstractCMSComponentData>	createComponentAndAssignToSlot(AbstractCMSComponentData component) Populates the component model from the component dto and saves the model using the ModelService
SearchResult<AbstractCMSComponentData>	findComponentByMask(java.lang.String mask, PageableData pageableData) For a given mask used as filter and a PageableData query, will return a page object consisting of the content list of the requested page number and the total number of entities for the given mask
protected java.lang.String	generateComponentName(java.lang.String typeCode) Deprecated. since 6.6
protected AbstractCMSComponentData	getAbstractCMSComponentDataResponse(AbstractCMSComponentData componentData, AbstractCMSComponentModel model) Converts the AbstractCMSComponentModel model object to AbstractCMSComponentData data object response.
protected CMSAdminSiteService	getAdminSiteService()
java.util.List<AbstractCMSComponentData>	getAllComponentItems() Find all component items.
protected AbstractPopulatingConverter<AbstractCMSComponentModel,AbstractCMSComponentData>	getBasicCMSComponentModelConverter()
protected CmsComponentConverterFactory	getCmsComponentConverterFactory()
protected ComponentDataPopulatorFactory	getCmsComponentPopulatorFactory()
protected java.util.Comparator<AbstractCMSComponentData>	getCmsItemComparator()
protected SearchResultConverter	getCmsSearchResultConverter()
protected CMSAdminComponentService	getComponentAdminService()
AbstractCMSComponentData	getComponentById(java.lang.String componentId, java.lang.String categoryCode, java.lang.String productCode, java.lang.String catalogCode) Returns the AbstractCMSComponentData object by component id restricted by categoryCode or productCode or catalogCode.
AbstractCMSComponentData	getComponentItemByUid(java.lang.String uid) Get a abstract component item by uid.
protected ComponentRenderingService	getComponentRenderingService()
SearchPageData<AbstractCMSComponentData>	getComponentsByIds(java.util.Collection<java.lang.String> componentIds, java.lang.String categoryCode, java.lang.String productCode, java.lang.String catalogCode, SearchPageData searchPageData) Returns the list of found AbstractCMSComponentData in SearchPageData.
protected CMSAdminContentSlotService	getContentSlotAdminService()
protected Validator	getCreateComponentValidator()
protected FacadeValidationService	getFacadeValidationService()
protected ModelService	getModelService()
protected SessionSearchRestrictionsDisabler	getSessionSearchRestrictionsDisabler()
protected Validator	getUpdateComponentValidator()
protected void	populateComponentModel(AbstractCMSComponentData componentData, AbstractCMSComponentModel componentModel) Deprecated. since 6.6
void	removeComponentItem(java.lang.String componentUid) Remove an existing component instance.
void	setAdminSiteService(CMSAdminSiteService adminSiteService)
void	setBasicCMSComponentModelConverter(AbstractPopulatingConverter<AbstractCMSComponentModel,AbstractCMSComponentData> basicCMSComponentModelConverter) Deprecated. since 6.6
void	setCmsComponentConverterFactory(CmsComponentConverterFactory cmsComponentConverterFactory) Deprecated. since 6.6
void	setCmsComponentPopulatorFactory(ComponentDataPopulatorFactory cmsComponentPopulatorFactory) Deprecated. since 6.6
void	setCmsItemComparator(java.util.Comparator<AbstractCMSComponentData> cmsItemComparator) Deprecated. since 6.6
void	setCmsSearchResultConverter(SearchResultConverter cmsSearchResultConverter)
void	setComponentAdminService(CMSAdminComponentService componentAdminService)
void	setComponentRenderingService(ComponentRenderingService componentRenderingService)
void	setContentSlotAdminService(CMSAdminContentSlotService contentSlotAdminService)
void	setCreateComponentValidator(Validator createComponentValidator) Deprecated. since 6.6
void	setFacadeValidationService(FacadeValidationService facadeValidationService)
void	setModelService(ModelService modelService)
void	setSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler)
void	setUpdateComponentValidator(Validator updateComponentValidator) Deprecated. since 6.6
void	updateComponentItem(java.lang.String componentUid, AbstractCMSComponentData componentData) Update a component item.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultComponentItemFacade

public DefaultComponentItemFacade()

Method Detail

getComponentById

public AbstractCMSComponentData getComponentById(java.lang.String componentId,
                                                 java.lang.String categoryCode,
                                                 java.lang.String productCode,
                                                 java.lang.String catalogCode)
                                          throws CMSItemNotFoundException

Description copied from interface: ComponentItemFacade

Returns the AbstractCMSComponentData object by component id restricted by categoryCode or productCode or catalogCode.

Specified by:

getComponentById in interface ComponentItemFacade

Parameters:

componentId - the component id

categoryCode - the optional category code

productCode - the optional product code

catalogCode - the optional catalog code

Returns:

the AbstractCMSComponentData object

Throws:

CMSItemNotFoundException - if the component is restricted or not visible.

getComponentsByIds

public SearchPageData<AbstractCMSComponentData> getComponentsByIds(java.util.Collection<java.lang.String> componentIds,
                                                                   java.lang.String categoryCode,
                                                                   java.lang.String productCode,
                                                                   java.lang.String catalogCode,
                                                                   SearchPageData searchPageData)

Description copied from interface: ComponentItemFacade

Returns the list of found AbstractCMSComponentData in SearchPageData. The result is restricted by categoryCode or productCode or catalogCode.

Specified by:

getComponentsByIds in interface ComponentItemFacade

Parameters:

componentIds - the list of component id

categoryCode - the optional category code

productCode - the optional product code

catalogCode - the optional catalog code

searchPageData - the searchPageData contains requested pagination and sorting information

Returns:

the list of found AbstractCMSComponentData in SearchPageData. If nothing is found the empty list is returned.

addComponentItem

public AbstractCMSComponentData addComponentItem(AbstractCMSComponentData component)

Description copied from interface: ComponentItemFacade

Adds a new component instance and assigns it to a slot.

Specified by:

addComponentItem in interface ComponentItemFacade

Parameters:

component - the AbstractCMSComponentData

Returns:

the AbstractCMSComponentData

createComponentAndAssignToSlot

protected java.util.function.Supplier<AbstractCMSComponentData> createComponentAndAssignToSlot(AbstractCMSComponentData component)

Populates the component model from the component dto and saves the model using the ModelService

Parameters:

component - - the component model to be created

Returns:

a AbstractCMSComponentData dto

getAbstractCMSComponentDataResponse

protected AbstractCMSComponentData getAbstractCMSComponentDataResponse(AbstractCMSComponentData componentData,
                                                                       AbstractCMSComponentModel model)

Converts the AbstractCMSComponentModel model object to AbstractCMSComponentData data object response.

Parameters:

componentData - the Data object that contains information about the current slot, the current page and position.

model - the object model to be converted.

Returns:

the AbstractCMSComponentData response object.

removeComponentItem

public void removeComponentItem(java.lang.String componentUid)
                         throws CMSItemNotFoundException

Description copied from interface: ComponentItemFacade

Remove an existing component instance.

Specified by:

removeComponentItem in interface ComponentItemFacade

Parameters:

componentUid - - the uid of the cms component

Throws:

CMSItemNotFoundException - - when no component exists for the given UID

getAllComponentItems

public java.util.List<AbstractCMSComponentData> getAllComponentItems()

Description copied from interface: ComponentItemFacade

Find all component items.

Specified by:

getAllComponentItems in interface ComponentItemFacade

Returns:

list of AbstractCMSComponentData; never null

findComponentByMask

public SearchResult<AbstractCMSComponentData> findComponentByMask(java.lang.String mask,
                                                                  PageableData pageableData)

Description copied from interface: ComponentItemFacade

For a given mask used as filter and a PageableData query, will return a page object consisting of the content list of the requested page number and the total number of entities for the given mask

Specified by:

findComponentByMask in interface ComponentItemFacade

Parameters:

mask - the string value on which components will be filtered, implementations may choose to filter on the component name

pageableData - the PageableData object containing the page request details. PageableData may contain a String value for sort, this will be used by a sorting strategy to select the most appropriate query or resort to a default one.

Returns:

list of component data fulfilling search query

getComponentItemByUid

public AbstractCMSComponentData getComponentItemByUid(java.lang.String uid)
                                               throws CMSItemNotFoundException

Description copied from interface: ComponentItemFacade

Get a abstract component item by uid.

Specified by:

getComponentItemByUid in interface ComponentItemFacade

Parameters:

uid - the uid of the cms component

Returns:

AbstractCMSComponentData the AbstractCMSComponentData

Throws:

CMSItemNotFoundException - when the component is unable to be found from the id

updateComponentItem

public void updateComponentItem(java.lang.String componentUid,
                                AbstractCMSComponentData componentData)
                         throws CMSItemNotFoundException

Description copied from interface: ComponentItemFacade

Update a component item.

Specified by:

updateComponentItem in interface ComponentItemFacade

Parameters:

componentUid - - the uid of the cms component

componentData - - the dto containing component attribute values

Throws:

CMSItemNotFoundException - - when the component is unable to be found from the id

populateComponentModel

@Deprecated
protected void populateComponentModel(AbstractCMSComponentData componentData,
                                                  AbstractCMSComponentModel componentModel)

Deprecated. since 6.6

Populates the Component Model, preparing it to be saved.

Parameters:

componentData - the AbstractCMSComponentData source data

componentModel - the AbstractCMSComponentModel target model

generateComponentName

@Deprecated
protected java.lang.String generateComponentName(java.lang.String typeCode)

Deprecated. since 6.6

buildUpdateComponentValidationDto

@Deprecated
protected UpdateComponentValidationDto buildUpdateComponentValidationDto(java.lang.String originalUid,
                                                                                     AbstractCMSComponentData component)

Deprecated. since 6.6

Build a DTO for validating a component to be updated.

Parameters:

originalUid -

component -

Returns:

the validation DTO

getComponentAdminService

protected CMSAdminComponentService getComponentAdminService()

setComponentAdminService

public void setComponentAdminService(CMSAdminComponentService componentAdminService)

getContentSlotAdminService

protected CMSAdminContentSlotService getContentSlotAdminService()

setContentSlotAdminService

public void setContentSlotAdminService(CMSAdminContentSlotService contentSlotAdminService)

getAdminSiteService

protected CMSAdminSiteService getAdminSiteService()

setAdminSiteService

public void setAdminSiteService(CMSAdminSiteService adminSiteService)

setCmsComponentConverterFactory

@Deprecated
public void setCmsComponentConverterFactory(CmsComponentConverterFactory cmsComponentConverterFactory)

Deprecated. since 6.6

getCmsComponentConverterFactory

protected CmsComponentConverterFactory getCmsComponentConverterFactory()

getCmsComponentPopulatorFactory

protected ComponentDataPopulatorFactory getCmsComponentPopulatorFactory()

setCmsComponentPopulatorFactory

@Deprecated
public void setCmsComponentPopulatorFactory(ComponentDataPopulatorFactory cmsComponentPopulatorFactory)

Deprecated. since 6.6

setBasicCMSComponentModelConverter

@Deprecated
public void setBasicCMSComponentModelConverter(AbstractPopulatingConverter<AbstractCMSComponentModel,AbstractCMSComponentData> basicCMSComponentModelConverter)

Deprecated. since 6.6

getBasicCMSComponentModelConverter

protected AbstractPopulatingConverter<AbstractCMSComponentModel,AbstractCMSComponentData> getBasicCMSComponentModelConverter()

setCmsItemComparator

@Deprecated
public void setCmsItemComparator(java.util.Comparator<AbstractCMSComponentData> cmsItemComparator)

Deprecated. since 6.6

getCmsItemComparator

protected java.util.Comparator<AbstractCMSComponentData> getCmsItemComparator()

getCreateComponentValidator

protected Validator getCreateComponentValidator()

setCreateComponentValidator

@Deprecated
public void setCreateComponentValidator(Validator createComponentValidator)

Deprecated. since 6.6

getFacadeValidationService

protected FacadeValidationService getFacadeValidationService()

setFacadeValidationService

public void setFacadeValidationService(FacadeValidationService facadeValidationService)

getUpdateComponentValidator

protected Validator getUpdateComponentValidator()

setUpdateComponentValidator

@Deprecated
public void setUpdateComponentValidator(Validator updateComponentValidator)

Deprecated. since 6.6

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getCmsSearchResultConverter

protected SearchResultConverter getCmsSearchResultConverter()

setCmsSearchResultConverter

public void setCmsSearchResultConverter(SearchResultConverter cmsSearchResultConverter)

getSessionSearchRestrictionsDisabler

protected SessionSearchRestrictionsDisabler getSessionSearchRestrictionsDisabler()

setSessionSearchRestrictionsDisabler

public void setSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler)

getComponentRenderingService

protected ComponentRenderingService getComponentRenderingService()

setComponentRenderingService

public void setComponentRenderingService(ComponentRenderingService componentRenderingService)