de.hybris.platform.cms2.servicelayer.services.impl

Class DefaultCMSPreviewService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

de.hybris.platform.cms2.servicelayer.services.impl.DefaultCMSPreviewService

All Implemented Interfaces:

CMSPreviewService, java.io.Serializable

public class DefaultCMSPreviewService
extends AbstractCMSService
implements CMSPreviewService

Default implementation of CMSPreviewService interface.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

CURRENTCATALOGVERSION, CURRENTSITE

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultCMSPreviewService()

Method Summary

Modifier and Type	Method and Description
PreviewDataModel	clonePreviewData(PreviewDataModel original) Clones given PreviewDataModel Note:
CMSPreviewTicketModel	createPreviewTicket(PreviewDataModel previewData) Creates a new CMSPreviewTicketModel with a unique ID, which contains the passed preview context, previewData.
protected java.lang.String	generateTicketId()
<any>	getCmsPagePreviewCriteriaDataFactory()
protected CMSPreviewTicketDao	getCmsPreviewTicketDao()
protected CMSSiteService	getCmsSiteService()
java.util.Collection<CatalogModel>	getEditableCatalogs(CMSSiteModel cmsSiteModel, CatalogVersionModel selectedCatalogVersion) Retrieves all editable catalogs for current site Note: Catalog versions from those catalog can be edited within live edit mode in CMSCockpit
PagePreviewCriteriaData	getPagePreviewCriteria() Returns a object generated from the preview ticket stored in the session.
CMSPreviewTicketModel	getPreviewTicket(java.lang.String ticketId) Returns the preview ticket with ID ticketId.
protected TaskService	getTaskService()
boolean	isVersioningPreview() Checks if we are in preview mode for a versioned page by checking the presence of a cmsTicketId in session and a in the CMSPreviewTicketModel.
void	setCmsPagePreviewCriteriaDataFactory(<any> cmsPagePreviewCriteriaDataFactory)
void	setCmsPreviewTicketDao(CMSPreviewTicketDao cmsPreviewTicketDao)
void	setCmsSiteService(CMSSiteService cmsSiteService)
void	setTaskService(TaskService taskService)
java.lang.String	storePreviewTicket(CMSPreviewTicketModel ticket) Persists the supplied CMSPreviewTicketModel ticket.

Methods inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

getBaseSiteService, getCurrentCatalogVersion, getCurrentSite, getSearchRestrictionService, getUserService, setBaseSiteService, setSearchRestrictionService, setUserService

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCMSPreviewService

public DefaultCMSPreviewService()

Method Detail

clonePreviewData

public PreviewDataModel clonePreviewData(PreviewDataModel original)

Description copied from interface: CMSPreviewService

Clones given PreviewDataModel

Note:

Specified by:

clonePreviewData in interface CMSPreviewService

Parameters:

original - current PreviewDataModel

Returns:

cloned PreviewDataModel

createPreviewTicket

public CMSPreviewTicketModel createPreviewTicket(PreviewDataModel previewData)

Creates a new CMSPreviewTicketModel with a unique ID, which contains the passed preview context, previewData.

Note: Preview tickets are only valid for a limited period of time and the returned ticket will be automatically removed once no longer valid.

Specified by:

createPreviewTicket in interface CMSPreviewService

Parameters:

previewData - the preview context for the ticket

Returns:

newly created preview ticket with the supplied context

See Also:

CMSPreviewService.getPreviewTicket(String), CMSPreviewService.storePreviewTicket(CMSPreviewTicketModel)

getEditableCatalogs

public java.util.Collection<CatalogModel> getEditableCatalogs(CMSSiteModel cmsSiteModel,
                                                              CatalogVersionModel selectedCatalogVersion)

Retrieves all editable catalogs for current site

Note:
Catalog versions from those catalog can be edited within live edit mode in CMSCockpit

Specified by:

getEditableCatalogs in interface CMSPreviewService

Parameters:

cmsSiteModel - current CMS Site

selectedCatalogVersion - current Content Catalog Version

Returns:

catalog list that contains catalog versions which can be changed in live edit session

getPreviewTicket

public CMSPreviewTicketModel getPreviewTicket(java.lang.String ticketId)

Returns the preview ticket with ID ticketId.

Specified by:

getPreviewTicket in interface CMSPreviewService

Parameters:

ticketId - unique ID of the ticket

Returns:

the ticket with ID ticketId or null if no ticket with that ID is available

See Also:

CMSPreviewService.createPreviewTicket(PreviewDataModel), CMSPreviewService.storePreviewTicket(CMSPreviewTicketModel)

storePreviewTicket

public java.lang.String storePreviewTicket(CMSPreviewTicketModel ticket)

Persists the supplied CMSPreviewTicketModel ticket.

Note: Storing a preview ticket will not extend its remaining life time.

Specified by:

storePreviewTicket in interface CMSPreviewService

Parameters:

ticket - the preview ticket to persist

Returns:

the id of the stored ticket

See Also:

CMSPreviewService.createPreviewTicket(PreviewDataModel), CMSPreviewService.getPreviewTicket(String)

getPagePreviewCriteria

public PagePreviewCriteriaData getPagePreviewCriteria()

Returns a object generated from the preview ticket stored in the session.

Specified by:

getPagePreviewCriteria in interface CMSPreviewService

isVersioningPreview

public boolean isVersioningPreview()

Checks if we are in preview mode for a versioned page by checking the presence of a cmsTicketId in session and a in the CMSPreviewTicketModel.

Specified by:

isVersioningPreview in interface CMSPreviewService

Returns:

true if in preview mode with a version

generateTicketId

protected java.lang.String generateTicketId()

getCmsPreviewTicketDao

protected CMSPreviewTicketDao getCmsPreviewTicketDao()

setCmsPreviewTicketDao

public void setCmsPreviewTicketDao(CMSPreviewTicketDao cmsPreviewTicketDao)

getCmsSiteService

protected CMSSiteService getCmsSiteService()

setCmsSiteService

public void setCmsSiteService(CMSSiteService cmsSiteService)

getTaskService

protected TaskService getTaskService()

setTaskService

public void setTaskService(TaskService taskService)

getCmsPagePreviewCriteriaDataFactory

public <any> getCmsPagePreviewCriteriaDataFactory()

setCmsPagePreviewCriteriaDataFactory

public void setCmsPagePreviewCriteriaDataFactory(<any> cmsPagePreviewCriteriaDataFactory)