Class DefaultCMSVersionFacade
java.lang.Object
de.hybris.platform.cmsfacades.version.impl.DefaultCMSVersionFacade
- All Implemented Interfaces:
CMSVersionFacade
Default implementation of the
CMSVersionFacade.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcreateRollbackAutoVersion(CMSVersionData cmsVersionData) Creates a CMSVersionModel of the current page with a preset version label and descriptioncreateVersion(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 criteriaprotected CMSItemConverterprotected Converter<CMSVersionModel,CMSVersionData> protected org.springframework.beans.factory.ObjectFactory<CMSVersionData>protected Populator<CMSVersionModel,Map<String, Object>> protected org.springframework.beans.factory.ObjectFactory<CMSVersionSearchData>protected CMSVersionSearchServiceprotected CMSVersionServiceprotected org.springframework.validation.Validatorprotected org.springframework.validation.Validatorprotected FacadeValidationServiceprotected org.springframework.validation.ValidatorgetItemByVersion(CMSVersionData cmsVersionData) Returns a CMSItem by its versionUid and item uuid.protected ItemDataPopulatorProviderprotected StringgetLocalizedDescription(String versionLabel) Returns the localized string for the version description.protected ModelServiceprotected PermissionCRUDServiceprotected org.springframework.validation.Validatorprotected SessionSearchRestrictionsDisablerprotected org.springframework.transaction.PlatformTransactionManagerprotected UniqueItemIdentifierServiceprotected org.springframework.validation.ValidatorgetVersion(String versionUid) Retrieves a CMSVersionData for the version identified by its uidprotected KeyGeneratorvoidrollbackVersion(CMSVersionData cmsVersionData) Rolls back to a CMSVersionModel for an itemvoidsetCmsItemConverter(CMSItemConverter cmsItemConverter) voidsetCmsVersionDataConverter(Converter<CMSVersionModel, CMSVersionData> cmsVersionDataConverter) voidsetCmsVersionDataDataFactory(org.springframework.beans.factory.ObjectFactory<CMSVersionData> cmsVersionDataDataFactory) voidsetCmsVersionItemCustomAttributesPopulator(Populator<CMSVersionModel, Map<String, Object>> cmsVersionItemCustomAttributesPopulator) voidsetCmsVersionSearchDataFactory(org.springframework.beans.factory.ObjectFactory<CMSVersionSearchData> cmsVersionSearchDataFactory) voidsetCmsVersionSearchService(CMSVersionSearchService cmsVersionSearchService) voidsetCmsVersionService(CMSVersionService cmsVersionService) voidsetCreateCMSVersionValidator(org.springframework.validation.Validator createCMSVersionValidator) voidsetDeleteCMSVersionValidator(org.springframework.validation.Validator deleteCMSVersionValidator) voidsetFacadeValidationService(FacadeValidationService facadeValidationService) voidsetGetCMSVersionsForItemValidator(org.springframework.validation.Validator getCMSVersionsForItemValidator) voidsetItemDataPopulatorProvider(ItemDataPopulatorProvider itemDataPopulatorProvider) voidsetModelService(ModelService modelService) voidsetPermissionCRUDService(PermissionCRUDService permissionCRUDService) voidsetRollbackCMSVersionValidator(org.springframework.validation.Validator rollbackCMSVersionValidator) voidsetSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler) voidsetTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager) voidsetUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService) voidsetUpdateCMSVersionValidator(org.springframework.validation.Validator updateCMSVersionValidator) voidsetVersionLabelKeyGenerator(KeyGenerator versionLabelKeyGenerator) protected voidthrowTypePermissionException(String permissionName, String typeCode) ThrowsTypePermissionExceptionif current user does not have permission for typeCode.updateVersion(CMSVersionData cmsVersionData) Updates a CMSVersionModel for an item
-
Constructor Details
-
DefaultCMSVersionFacade
public DefaultCMSVersionFacade()
-
-
Method Details
-
findVersionsForItem
public SearchResult<CMSVersionData> findVersionsForItem(String itemUUID, String mask, PageableData pageableData) throws CMSItemNotFoundException Description copied from interface:CMSVersionFacadeRetrieves a paginated result of CMSVersionData matching the search criteria- Specified by:
findVersionsForItemin interfaceCMSVersionFacade- 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
Description copied from interface:CMSVersionFacadeRetrieves a CMSVersionData for the version identified by its uid- Specified by:
getVersionin interfaceCMSVersionFacade- Parameters:
versionUid- the uid of the cms version- Returns:
- the
CMSVersionData - Throws:
CMSVersionNotFoundException- when no version found for the given version id
-
createVersion
Description copied from interface:CMSVersionFacadeCreates a CMSVersionModel for an item- Specified by:
createVersionin interfaceCMSVersionFacade- Parameters:
cmsVersionData- the version data object- Returns:
- the
CMSVersionData
-
updateVersion
Description copied from interface:CMSVersionFacadeUpdates a CMSVersionModel for an item- Specified by:
updateVersionin interfaceCMSVersionFacade- Parameters:
cmsVersionData- the version data object- Returns:
- the
CMSVersionData
-
rollbackVersion
Description copied from interface:CMSVersionFacadeRolls back to a CMSVersionModel for an item- Specified by:
rollbackVersionin interfaceCMSVersionFacade- Parameters:
cmsVersionData- the version data object
-
getItemByVersion
Returns a CMSItem by its versionUid and item uuid. For more information about Unique Identifiers, seeUniqueItemIdentifierService. The generated preview object can possible generated item during processing. Those items must never be saved to the database. To achieve this it's necessary to wrap the whole process in transaction and rollback transaction at the end.- Specified by:
getItemByVersionin interfaceCMSVersionFacade- Parameters:
cmsVersionData- the version data object- Returns:
- a CMS item as a map
-
createRollbackAutoVersion
Creates a CMSVersionModel of the current page with a preset version label and description- Parameters:
cmsVersionData- the version data object containing information of the page to be versioned
-
getLocalizedDescription
Returns the localized string for the version description. This is used to auto fill the description for an automatic version created during a rollback operation.- Parameters:
versionLabel-- Returns:
- The localized description
-
deleteVersion
Description copied from interface:CMSVersionFacadeDeletes a CMSVersionModel for an item- Specified by:
deleteVersionin interfaceCMSVersionFacade- Parameters:
cmsVersionData- the version data object
-
throwTypePermissionException
ThrowsTypePermissionExceptionif current user does not have permission for typeCode.- Parameters:
permissionName-typeCode-
-
getUniqueItemIdentifierService
-
setUniqueItemIdentifierService
-
getCmsVersionService
-
setCmsVersionService
-
getCmsVersionSearchService
-
setCmsVersionSearchService
-
getFacadeValidationService
-
setFacadeValidationService
-
getModelService
-
setModelService
-
getCmsVersionDataConverter
-
setCmsVersionDataConverter
public void setCmsVersionDataConverter(Converter<CMSVersionModel, CMSVersionData> cmsVersionDataConverter) -
getCreateCMSVersionValidator
protected org.springframework.validation.Validator getCreateCMSVersionValidator() -
setCreateCMSVersionValidator
public void setCreateCMSVersionValidator(org.springframework.validation.Validator createCMSVersionValidator) -
getUpdateCMSVersionValidator
protected org.springframework.validation.Validator getUpdateCMSVersionValidator() -
setUpdateCMSVersionValidator
public void setUpdateCMSVersionValidator(org.springframework.validation.Validator updateCMSVersionValidator) -
getRollbackCMSVersionValidator
protected org.springframework.validation.Validator getRollbackCMSVersionValidator() -
setRollbackCMSVersionValidator
public void setRollbackCMSVersionValidator(org.springframework.validation.Validator rollbackCMSVersionValidator) -
getCmsVersionSearchDataFactory
protected org.springframework.beans.factory.ObjectFactory<CMSVersionSearchData> getCmsVersionSearchDataFactory() -
setCmsVersionSearchDataFactory
public void setCmsVersionSearchDataFactory(org.springframework.beans.factory.ObjectFactory<CMSVersionSearchData> cmsVersionSearchDataFactory) -
getDeleteCMSVersionValidator
protected org.springframework.validation.Validator getDeleteCMSVersionValidator() -
setDeleteCMSVersionValidator
public void setDeleteCMSVersionValidator(org.springframework.validation.Validator deleteCMSVersionValidator) -
getSessionSearchRestrictionsDisabler
-
setSessionSearchRestrictionsDisabler
public void setSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler) -
getCmsItemConverter
-
setCmsItemConverter
-
getItemDataPopulatorProvider
-
setItemDataPopulatorProvider
-
getCmsVersionItemCustomAttributesPopulator
protected Populator<CMSVersionModel,Map<String, getCmsVersionItemCustomAttributesPopulator()Object>> -
setCmsVersionItemCustomAttributesPopulator
public void setCmsVersionItemCustomAttributesPopulator(Populator<CMSVersionModel, Map<String, Object>> cmsVersionItemCustomAttributesPopulator) -
getGetCMSVersionsForItemValidator
protected org.springframework.validation.Validator getGetCMSVersionsForItemValidator() -
setGetCMSVersionsForItemValidator
public void setGetCMSVersionsForItemValidator(org.springframework.validation.Validator getCMSVersionsForItemValidator) -
getCmsVersionDataDataFactory
protected org.springframework.beans.factory.ObjectFactory<CMSVersionData> getCmsVersionDataDataFactory() -
setCmsVersionDataDataFactory
public void setCmsVersionDataDataFactory(org.springframework.beans.factory.ObjectFactory<CMSVersionData> cmsVersionDataDataFactory) -
getVersionLabelKeyGenerator
-
setVersionLabelKeyGenerator
-
getTransactionManager
protected org.springframework.transaction.PlatformTransactionManager getTransactionManager() -
setTransactionManager
public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager) -
getPermissionCRUDService
-
setPermissionCRUDService
-