Interface CMSVersionFacade

All Known Implementing Classes:
DefaultCMSVersionFacade

public interface CMSVersionFacade
Content facade interface which deals with methods related to cms version operations.
  • Method Details

    • findVersionsForItem

      SearchResult<CMSVersionData> findVersionsForItem(String itemUUID, String mask, PageableData pageableData) throws CMSItemNotFoundException
      Retrieves a paginated result of CMSVersionData matching the search criteria
      Parameters:
      itemUUID - the universal unique identifier of the item being searched on
      mask - the mask applied when searching
      pageableData - the pagination object
      Returns:
      the search result object
      Throws:
      CMSItemNotFoundException - when no item found for the given itemUUID
    • getVersion

      Retrieves a CMSVersionData for the version identified by its uid
      Parameters:
      uid - the uid of the cms version
      Returns:
      the CMSVersionData
      Throws:
      CMSVersionNotFoundException - when no version found for the given version id
    • createVersion

      CMSVersionData createVersion(CMSVersionData cmsVersionData)
      Creates a CMSVersionModel for an item
      Parameters:
      cmsVersionData - the version data object
      Returns:
      the CMSVersionData
    • updateVersion

      CMSVersionData updateVersion(CMSVersionData cmsVersionData)
      Updates a CMSVersionModel for an item
      Parameters:
      cmsVersionData - the version data object
      Returns:
      the CMSVersionData
    • rollbackVersion

      void rollbackVersion(CMSVersionData cmsVersionData)
      Rolls back to a CMSVersionModel for an item
      Parameters:
      cmsVersionData - the version data object
    • deleteVersion

      void deleteVersion(CMSVersionData cmsVersionData)
      Deletes a CMSVersionModel for an item
      Parameters:
      cmsVersionData - the version data object
    • getItemByVersion

      Map<String,Object> getItemByVersion(CMSVersionData cmsVersionData)
      Returns a CMSItem by its versionUid and item uuid. For more information about Unique Identifiers, see UniqueItemIdentifierService.
      Parameters:
      cmsVersionData - the version data object
      Returns:
      a CMS item as a map