de.hybris.platform.cmsfacades.version

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 Type	Method and Description
CMSVersionData	createVersion(CMSVersionData cmsVersionData) Creates a CMSVersionModel for an item
void	deleteVersion(CMSVersionData cmsVersionData) Deletes a CMSVersionModel for an item
SearchResult<CMSVersionData>	findVersionsForItem(java.lang.String itemUUID, java.lang.String mask, PageableData pageableData) Retrieves a paginated result of CMSVersionData matching the search criteria
java.util.Map<java.lang.String,java.lang.Object>	getItemByVersion(CMSVersionData cmsVersionData) Returns a CMSItem by its versionUid and item uuid.
CMSVersionData	getVersion(java.lang.String uid) Retrieves a CMSVersionData for the version identified by its uid
void	rollbackVersion(CMSVersionData cmsVersionData) Rolls back to a CMSVersionModel for an item
CMSVersionData	updateVersion(CMSVersionData cmsVersionData) Updates a CMSVersionModel for an item

Method Detail

findVersionsForItem

SearchResult<CMSVersionData> findVersionsForItem(java.lang.String itemUUID,
                                                 java.lang.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

CMSVersionData getVersion(java.lang.String uid)
                   throws CMSVersionNotFoundException

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

java.util.Map<java.lang.String,java.lang.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