Package 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 Details

    • findCMSItems

      List<Map<String,Object>> findCMSItems(List<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

      default List<Map<String,Object>> findCMSItems(List<String> uuids, String mode) throws CMSItemNotFoundException
      A Search for CMSItems by their universally unique identifiers.
      Parameters:
      uuids - - the list of uuids of the CMSItems to look for
      mode - - list of fields, which should be returned in response
      Returns:
      A list of the corresponding CMSItems
      Throws:
      CMSItemNotFoundException - if the item is not found

    • findCMSItems

      SearchResult<Map<String,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

      Map<String,Object> getCMSItemByUuid(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.

    • getCMSItemByUuid

      default Map<String,Object> getCMSItemByUuid(String uuid, String mode) 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
      mode - - list of fields, which should be returned in response
      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

      Map<String,Object> createItem(Map<String,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

      Map<String,Object> updateItem(String uuid, Map<String,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(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

      Map<String,Object> validateItemForUpdate(String uuid, Map<String,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

      Map<String,Object> validateItemForCreate(Map<String,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.