de.hybris.platform.cmsfacades.items

Interface ComponentItemFacade

All Known Implementing Classes:

DefaultComponentItemFacade

public interface ComponentItemFacade

Component facade interface which deals with methods related to component operations.

Method Summary

Modifier and Type	Method and Description
AbstractCMSComponentData	addComponentItem(AbstractCMSComponentData component) Deprecated. since 6.6. Please use PageContentSlotComponentFacade.addComponentToContentSlot(de.hybris.platform.cmsfacades.data.PageContentSlotComponentData) instead.
SearchResult<AbstractCMSComponentData>	findComponentByMask(java.lang.String mask, PageableData pageableData) Deprecated. since 6.6. Please use CMSItemFacade.findCMSItems(de.hybris.platform.cmsfacades.data.CMSItemSearchData, PageableData) instead.
java.util.List<AbstractCMSComponentData>	getAllComponentItems() Deprecated. since 6.6. Please use CMSItemFacade.findCMSItems(de.hybris.platform.cmsfacades.data.CMSItemSearchData, PageableData) instead.
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) Deprecated. since 6.6. Please use CMSItemFacade.getCMSItemByUuid(String) instead.
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.
void	removeComponentItem(java.lang.String componentUid) Deprecated. since 6.6. Please use CMSItemFacade.deleteCMSItemByUuid(String) instead.
void	updateComponentItem(java.lang.String componentUid, AbstractCMSComponentData componentData) Deprecated. since 6.6. Please use CMSItemFacade.updateItem(String, java.util.Map) instead.

Method Detail

getComponentById

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

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

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

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. The result is restricted by categoryCode or productCode or catalogCode.

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.

getAllComponentItems

@Deprecated
java.util.List<AbstractCMSComponentData> getAllComponentItems()

Deprecated. since 6.6. Please use CMSItemFacade.findCMSItems(de.hybris.platform.cmsfacades.data.CMSItemSearchData, PageableData) instead.

Find all component items.

Returns:

list of AbstractCMSComponentData; never null

findComponentByMask

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

Deprecated. since 6.6. Please use CMSItemFacade.findCMSItems(de.hybris.platform.cmsfacades.data.CMSItemSearchData, PageableData) instead.

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

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

addComponentItem

@Deprecated
AbstractCMSComponentData addComponentItem(AbstractCMSComponentData component)
                                               throws ValidationException

Deprecated. since 6.6. Please use PageContentSlotComponentFacade.addComponentToContentSlot(de.hybris.platform.cmsfacades.data.PageContentSlotComponentData) instead.

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

Parameters:

component - the AbstractCMSComponentData

Returns:

the AbstractCMSComponentData

Throws:

ValidationException - throws it in case of validation failures.

removeComponentItem

@Deprecated
void removeComponentItem(java.lang.String componentUid)
                              throws CMSItemNotFoundException

Deprecated. since 6.6. Please use CMSItemFacade.deleteCMSItemByUuid(String) instead.

Remove an existing component instance.

Parameters:

componentUid - - the uid of the cms component

Throws:

CMSItemNotFoundException - - when no component exists for the given UID

getComponentItemByUid

@Deprecated
AbstractCMSComponentData getComponentItemByUid(java.lang.String uid)
                                                    throws CMSItemNotFoundException

Deprecated. since 6.6. Please use CMSItemFacade.getCMSItemByUuid(String) instead.

Get a abstract component item by uid.

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

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

Deprecated. since 6.6. Please use CMSItemFacade.updateItem(String, java.util.Map) instead.

Update a component item.

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