de.hybris.platform.cmsfacades.cmsitems

Interface CMSItemFacade

All Known Implementing Classes:

DefaultCMSItemFacade

public interface CMSItemFacade

Content facade interface which deals with CRUD and search operations related to any CMSItem by passing on valued Maps.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	createItem(java.util.Map<java.lang.String,java.lang.Object> itemMap) Create CMS Items given the attribute value map.
void	deleteCMSItemByUuid(java.lang.String uuid) Deletes one single CMSItem by its uuid (Universal Unique Identifier)
SearchResult<java.util.Map<java.lang.String,java.lang.Object>>	findCMSItems(CMSItemSearchData cmsItemSearchData, PageableData pageableData) A paged Search for CMSItems in a given catalogversion.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	findCMSItems(java.util.List<java.lang.String> uuids) A Search for CMSItems by their universally unique identifiers
java.util.Map<java.lang.String,java.lang.Object>	getCMSItemByUuid(java.lang.String uuid) Get one single CMSItem by its uuid (Universal Unique Identifier) For more information about Unique Identifiers, see UniqueItemIdentifierService
java.util.Map<java.lang.String,java.lang.Object>	updateItem(java.lang.String uuid, java.util.Map<java.lang.String,java.lang.Object> itemMap) Updates a CMS Item given the attribute value map and its uuid.
java.util.Map<java.lang.String,java.lang.Object>	validateItemForCreate(java.util.Map<java.lang.String,java.lang.Object> itemMap) Validates CMS Items given the attribute value map.
java.util.Map<java.lang.String,java.lang.Object>	validateItemForUpdate(java.lang.String uuid, java.util.Map<java.lang.String,java.lang.Object> itemMap) Validates a CMS Item given the attribute value map and its uuid.

Method Detail

findCMSItems

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> findCMSItems(java.util.List<java.lang.String> uuids)
                                                                       throws CMSItemNotFoundException

A Search for CMSItems by their universally unique identifiers

Parameters:

uuids - The list of uuids of the CMSItems to look for

Returns:

A list of the corresponding CMSItems

Throws:

CMSItemNotFoundException - if the item is not found

findCMSItems

SearchResult<java.util.Map<java.lang.String,java.lang.Object>> findCMSItems(CMSItemSearchData cmsItemSearchData,
                                                                            PageableData pageableData)

A paged Search for CMSItems in a given catalogversion. Optionally filter by name/uid or typeCode

Parameters:

cmsItemSearchData - The catalog and filter information

pageableData - The paging information

Returns:

A SearchResult containing the paging information and the results

Throws:

ValidationException - When catalog or paging information is missing

getCMSItemByUuid

java.util.Map<java.lang.String,java.lang.Object> getCMSItemByUuid(java.lang.String uuid)
                                                           throws CMSItemNotFoundException

Get one single CMSItem by its uuid (Universal Unique Identifier) For more information about Unique Identifiers, see UniqueItemIdentifierService

Parameters:

uuid - - the universal unique identifier

Returns:

the Map<String, Object> representation of the CMS Item

Throws:

CMSItemNotFoundException - when a CMS Item can not be found for a given uuid.

createItem

java.util.Map<java.lang.String,java.lang.Object> createItem(java.util.Map<java.lang.String,java.lang.Object> itemMap)
                                                     throws CMSItemNotFoundException

Create CMS Items given the attribute value map.

Parameters:

itemMap - - the Map<String, Object> that contains the attributes values for the new CMSItem.

Returns:

the Map tha represents the newly created CMS Item.

Throws:

CMSItemNotFoundException - when a CMS Item can not be found for a given uuid.

updateItem

java.util.Map<java.lang.String,java.lang.Object> updateItem(java.lang.String uuid,
                                                            java.util.Map<java.lang.String,java.lang.Object> itemMap)
                                                     throws CMSItemNotFoundException

Updates a CMS Item given the attribute value map and its uuid. For more information about Unique Identifiers, see UniqueItemIdentifierService

Parameters:

uuid - - the universal unique identifier

itemMap - - the Map<String, Object> that contains the attributes values for the new CMSItem.

Returns:

the Map tha represents the newly created CMS Item.

Throws:

CMSItemNotFoundException - when a CMS Item can not be found for a given uuid.

deleteCMSItemByUuid

void deleteCMSItemByUuid(java.lang.String uuid)
                  throws CMSItemNotFoundException

Deletes one single CMSItem by its uuid (Universal Unique Identifier)

Parameters:

uuid - - the universal unique identifier

Throws:

CMSItemNotFoundException - when a CMS Item can not be found for a given uuid.

validateItemForUpdate

java.util.Map<java.lang.String,java.lang.Object> validateItemForUpdate(java.lang.String uuid,
                                                                       java.util.Map<java.lang.String,java.lang.Object> itemMap)
                                                                throws CMSItemNotFoundException

Validates a CMS Item given the attribute value map and its uuid. For more information about Unique Identifiers, see UniqueItemIdentifierService

Parameters:

uuid - - the universal unique identifier

itemMap - - the Map<String, Object> that contains the attributes values for the new CMSItem.

Returns:

the Map that represents the CMS Item.

Throws:

CMSItemNotFoundException - when a CMS Item can not be found for a given uuid.

validateItemForCreate

java.util.Map<java.lang.String,java.lang.Object> validateItemForCreate(java.util.Map<java.lang.String,java.lang.Object> itemMap)
                                                                throws CMSItemNotFoundException

Validates CMS Items given the attribute value map.

Parameters:

itemMap - - the Map<String, Object> that contains the attributes values for the new CMSItem.

Returns:

the Map that represents the newly created CMS Item.

Throws:

CMSItemNotFoundException - when a CMS Item can not be found for a given uuid.