de.hybris.platform.cms2.servicelayer.services

Interface CMSPreviewService

All Known Implementing Classes:

DefaultCMSPreviewService

public interface CMSPreviewService

Service which provides preview and live edit functionality.

Responsible for managing preview data such as creating, validating and storing preview tickets and preview contexts.

Spring Bean ID:

cmsPreviewService

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.
java.util.Collection<CatalogModel>	getEditableCatalogs(CMSSiteModel cmsSiteModel, CatalogVersionModel activeCatalogVersion) 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.
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.
java.lang.String	storePreviewTicket(CMSPreviewTicketModel ticket) Persists the supplied CMSPreviewTicketModel ticket.

Method Detail

createPreviewTicket

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.

Parameters:

previewData - the preview context for the ticket

Returns:

newly created preview ticket with the supplied context

See Also:

getPreviewTicket(String), storePreviewTicket(CMSPreviewTicketModel)

getPreviewTicket

CMSPreviewTicketModel getPreviewTicket(java.lang.String ticketId)

Returns the preview ticket with ID ticketId.

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:

createPreviewTicket(PreviewDataModel), storePreviewTicket(CMSPreviewTicketModel)

storePreviewTicket

java.lang.String storePreviewTicket(CMSPreviewTicketModel ticket)

Persists the supplied CMSPreviewTicketModel ticket.

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

Parameters:

ticket - the preview ticket to persist

Returns:

the id of the stored ticket

See Also:

createPreviewTicket(PreviewDataModel), getPreviewTicket(String)

clonePreviewData

PreviewDataModel clonePreviewData(PreviewDataModel original)

Clones given PreviewDataModel

Note:

Parameters:

original - current PreviewDataModel

Returns:

cloned PreviewDataModel

getEditableCatalogs

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

Retrieves all editable catalogs for current site

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

Parameters:

cmsSiteModel - current CMS Site

activeCatalogVersion - current Content Catalog Version

Returns:

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

getPagePreviewCriteria

PagePreviewCriteriaData getPagePreviewCriteria()

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

isVersioningPreview

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.

Returns:

true if in preview mode with a version