Interface CMSVersionFacade
- All Known Implementing Classes:
DefaultCMSVersionFacade
public interface CMSVersionFacade
Content facade interface which deals with methods related to cms version operations.
-
Method Summary
Modifier and TypeMethodDescriptioncreateVersion(CMSVersionData cmsVersionData) Creates a CMSVersionModel for an itemvoiddeleteVersion(CMSVersionData cmsVersionData) Deletes a CMSVersionModel for an itemfindVersionsForItem(String itemUUID, String mask, PageableData pageableData) Retrieves a paginated result of CMSVersionData matching the search criteriagetItemByVersion(CMSVersionData cmsVersionData) Returns a CMSItem by its versionUid and item uuid.getVersion(String uid) Retrieves a CMSVersionData for the version identified by its uidvoidrollbackVersion(CMSVersionData cmsVersionData) Rolls back to a CMSVersionModel for an itemupdateVersion(CMSVersionData cmsVersionData) Updates a CMSVersionModel for an item
-
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 onmask- the mask applied when searchingpageableData- 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
Creates a CMSVersionModel for an item- Parameters:
cmsVersionData- the version data object- Returns:
- the
CMSVersionData
-
updateVersion
Updates a CMSVersionModel for an item- Parameters:
cmsVersionData- the version data object- Returns:
- the
CMSVersionData
-
rollbackVersion
Rolls back to a CMSVersionModel for an item- Parameters:
cmsVersionData- the version data object
-
deleteVersion
Deletes a CMSVersionModel for an item- Parameters:
cmsVersionData- the version data object
-
getItemByVersion
Returns a CMSItem by its versionUid and item uuid. For more information about Unique Identifiers, seeUniqueItemIdentifierService.- Parameters:
cmsVersionData- the version data object- Returns:
- a CMS item as a map
-