Package de.hybris.platform.cmsfacades.version.impl

Class DefaultCMSVersionFacade

java.lang.Object

de.hybris.platform.cmsfacades.version.impl.DefaultCMSVersionFacade

All Implemented Interfaces:

CMSVersionFacade

public class DefaultCMSVersionFacade
extends java.lang.Object
implements CMSVersionFacade

Default implementation of the CMSVersionFacade.

Constructor Summary

Constructors

Constructor	Description
DefaultCMSVersionFacade()

Method Summary

Modifier and Type	Method	Description
protected void	createRollbackAutoVersion(CMSVersionData cmsVersionData)	Creates a CMSVersionModel of the current page with a preset version label 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
protected CMSItemConverter	getCmsItemConverter()
protected Converter<CMSVersionModel,CMSVersionData>	getCmsVersionDataConverter()
protected org.springframework.beans.factory.ObjectFactory<CMSVersionData>	getCmsVersionDataDataFactory()
protected Populator<CMSVersionModel,java.util.Map<java.lang.String,java.lang.Object>>	getCmsVersionItemCustomAttributesPopulator()
protected org.springframework.beans.factory.ObjectFactory<CMSVersionSearchData>	getCmsVersionSearchDataFactory()
protected CMSVersionSearchService	getCmsVersionSearchService()
protected CMSVersionService	getCmsVersionService()
protected org.springframework.validation.Validator	getCreateCMSVersionValidator()
protected org.springframework.validation.Validator	getDeleteCMSVersionValidator()
protected FacadeValidationService	getFacadeValidationService()
protected org.springframework.validation.Validator	getGetCMSVersionsForItemValidator()
java.util.Map<java.lang.String,java.lang.Object>	getItemByVersion(CMSVersionData cmsVersionData)	Returns a CMSItem by its versionUid and item uuid.
protected ItemDataPopulatorProvider	getItemDataPopulatorProvider()
protected java.lang.String	getLocalizedDescription(java.lang.String versionLabel)	Returns the localized string for the version description.
protected ModelService	getModelService()
protected PermissionCRUDService	getPermissionCRUDService()
protected org.springframework.validation.Validator	getRollbackCMSVersionValidator()
protected SessionSearchRestrictionsDisabler	getSessionSearchRestrictionsDisabler()
protected org.springframework.transaction.PlatformTransactionManager	getTransactionManager()
protected UniqueItemIdentifierService	getUniqueItemIdentifierService()
protected org.springframework.validation.Validator	getUpdateCMSVersionValidator()
CMSVersionData	getVersion(java.lang.String versionUid)	Retrieves a CMSVersionData for the version identified by its uid
protected KeyGenerator	getVersionLabelKeyGenerator()
void	rollbackVersion(CMSVersionData cmsVersionData)	Rolls back to a CMSVersionModel for an item
void	setCmsItemConverter(CMSItemConverter cmsItemConverter)
void	setCmsVersionDataConverter(Converter<CMSVersionModel,CMSVersionData> cmsVersionDataConverter)
void	setCmsVersionDataDataFactory(org.springframework.beans.factory.ObjectFactory<CMSVersionData> cmsVersionDataDataFactory)
void	setCmsVersionItemCustomAttributesPopulator(Populator<CMSVersionModel,java.util.Map<java.lang.String,java.lang.Object>> cmsVersionItemCustomAttributesPopulator)
void	setCmsVersionSearchDataFactory(org.springframework.beans.factory.ObjectFactory<CMSVersionSearchData> cmsVersionSearchDataFactory)
void	setCmsVersionSearchService(CMSVersionSearchService cmsVersionSearchService)
void	setCmsVersionService(CMSVersionService cmsVersionService)
void	setCreateCMSVersionValidator(org.springframework.validation.Validator createCMSVersionValidator)
void	setDeleteCMSVersionValidator(org.springframework.validation.Validator deleteCMSVersionValidator)
void	setFacadeValidationService(FacadeValidationService facadeValidationService)
void	setGetCMSVersionsForItemValidator(org.springframework.validation.Validator getCMSVersionsForItemValidator)
void	setItemDataPopulatorProvider(ItemDataPopulatorProvider itemDataPopulatorProvider)
void	setModelService(ModelService modelService)
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)
void	setRollbackCMSVersionValidator(org.springframework.validation.Validator rollbackCMSVersionValidator)
void	setSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler)
void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
void	setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)
void	setUpdateCMSVersionValidator(org.springframework.validation.Validator updateCMSVersionValidator)
void	setVersionLabelKeyGenerator(KeyGenerator versionLabelKeyGenerator)
protected void	throwTypePermissionException(java.lang.String permissionName, java.lang.String typeCode)	Throws TypePermissionException if current user does not have permission for typeCode.
CMSVersionData	updateVersion(CMSVersionData cmsVersionData)	Updates a CMSVersionModel for an item

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCMSVersionFacade

public DefaultCMSVersionFacade()

Method Detail

findVersionsForItem

public SearchResult<CMSVersionData> findVersionsForItem(java.lang.String itemUUID,
                                                        java.lang.String mask,
                                                        PageableData pageableData)
                                                 throws CMSItemNotFoundException

Description copied from interface: CMSVersionFacade

Retrieves a paginated result of CMSVersionData matching the search criteria

Specified by:

findVersionsForItem in interface CMSVersionFacade

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

public CMSVersionData getVersion(java.lang.String versionUid)
                          throws CMSVersionNotFoundException

Description copied from interface: CMSVersionFacade

Retrieves a CMSVersionData for the version identified by its uid

Specified by:

getVersion in interface CMSVersionFacade

Parameters:

versionUid - the uid of the cms version

Returns:

the CMSVersionData

Throws:

CMSVersionNotFoundException - when no version found for the given version id

createVersion

public CMSVersionData createVersion(CMSVersionData cmsVersionData)

Description copied from interface: CMSVersionFacade

Creates a CMSVersionModel for an item

Specified by:

createVersion in interface CMSVersionFacade

Parameters:

cmsVersionData - the version data object

Returns:

the CMSVersionData

updateVersion

public CMSVersionData updateVersion(CMSVersionData cmsVersionData)

Description copied from interface: CMSVersionFacade

Updates a CMSVersionModel for an item

Specified by:

updateVersion in interface CMSVersionFacade

Parameters:

cmsVersionData - the version data object

Returns:

the CMSVersionData

rollbackVersion

public void rollbackVersion(CMSVersionData cmsVersionData)

Description copied from interface: CMSVersionFacade

Rolls back to a CMSVersionModel for an item

Specified by:

rollbackVersion in interface CMSVersionFacade

Parameters:

cmsVersionData - the version data object

getItemByVersion

public 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. 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:

getItemByVersion in interface CMSVersionFacade

Parameters:

cmsVersionData - the version data object

Returns:

a CMS item as a map

createRollbackAutoVersion

protected void createRollbackAutoVersion(CMSVersionData cmsVersionData)

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

protected java.lang.String getLocalizedDescription(java.lang.String versionLabel)

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

public void deleteVersion(CMSVersionData cmsVersionData)

Description copied from interface: CMSVersionFacade

Deletes a CMSVersionModel for an item

Specified by:

deleteVersion in interface CMSVersionFacade

Parameters:

cmsVersionData - the version data object

throwTypePermissionException

protected void throwTypePermissionException(java.lang.String permissionName,
                                            java.lang.String typeCode)

Throws TypePermissionException if current user does not have permission for typeCode.

Parameters:

permissionName -

typeCode -

getUniqueItemIdentifierService

protected UniqueItemIdentifierService getUniqueItemIdentifierService()

setUniqueItemIdentifierService

public void setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)

getCmsVersionService

protected CMSVersionService getCmsVersionService()

setCmsVersionService

public void setCmsVersionService(CMSVersionService cmsVersionService)

getCmsVersionSearchService

protected CMSVersionSearchService getCmsVersionSearchService()

setCmsVersionSearchService

public void setCmsVersionSearchService(CMSVersionSearchService cmsVersionSearchService)

getFacadeValidationService

protected FacadeValidationService getFacadeValidationService()

setFacadeValidationService

public void setFacadeValidationService(FacadeValidationService facadeValidationService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getCmsVersionDataConverter

protected Converter<CMSVersionModel,CMSVersionData> 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

protected SessionSearchRestrictionsDisabler getSessionSearchRestrictionsDisabler()

setSessionSearchRestrictionsDisabler

public void setSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler)

getCmsItemConverter

protected CMSItemConverter getCmsItemConverter()

setCmsItemConverter

public void setCmsItemConverter(CMSItemConverter cmsItemConverter)

getItemDataPopulatorProvider

protected ItemDataPopulatorProvider getItemDataPopulatorProvider()

setItemDataPopulatorProvider

public void setItemDataPopulatorProvider(ItemDataPopulatorProvider itemDataPopulatorProvider)

getCmsVersionItemCustomAttributesPopulator

protected Populator<CMSVersionModel,java.util.Map<java.lang.String,java.lang.Object>> getCmsVersionItemCustomAttributesPopulator()

setCmsVersionItemCustomAttributesPopulator

public void setCmsVersionItemCustomAttributesPopulator(Populator<CMSVersionModel,java.util.Map<java.lang.String,java.lang.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

protected KeyGenerator getVersionLabelKeyGenerator()

setVersionLabelKeyGenerator

public void setVersionLabelKeyGenerator(KeyGenerator versionLabelKeyGenerator)

getTransactionManager

protected org.springframework.transaction.PlatformTransactionManager getTransactionManager()

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

getPermissionCRUDService

protected PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)