org.exoplatform.services.wcm.publication

Interface WCMPublicationService

All Known Implementing Classes:

WCMPublicationServiceImpl, WCMPublicationServiceImpl

public interface WCMPublicationService

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPDATE_EVENT

Method Summary

Modifier and Type	Method and Description
void	addPublicationPlugin(WebpagePublicationPlugin p) Add a Web Publication Plugin to the service.
void	enrollNodeInLifecycle(javax.jcr.Node node, String lifecycleName) Enroll in a web page publication lifecycle.
void	enrollNodeInLifecycle(javax.jcr.Node node, String siteName, String remoteUser) Enroll this node in the default publication lifecycle.
String	getContentState(javax.jcr.Node node) returns the current state of the content.
Map<String,WebpagePublicationPlugin>	getWebpagePublicationPlugins() Retrieves all added web page publication plugins.
boolean	isEnrolledInWCMLifecycle(javax.jcr.Node node) Checks if is enrolled in wcm lifecycle.
void	unsubcribeLifecycle(javax.jcr.Node node) Unsubcribe node from a lifecycle plugin.
void	updateLifecyleOnChangeContent(javax.jcr.Node node, String siteName, String remoteUser) Called by create and edit listeners.
void	updateLifecyleOnChangeContent(javax.jcr.Node node, String siteName, String remoteUser, String newState) It allows to update the lifecycle of the content with a new state.

Field Detail

UPDATE_EVENT

static final String UPDATE_EVENT

See Also:

Constant Field Values

Method Detail

addPublicationPlugin

void addPublicationPlugin(WebpagePublicationPlugin p)

Add a Web Publication Plugin to the service. The method caches all added plugins.

Parameters:

p - the plugin to add

getWebpagePublicationPlugins

Map<String,WebpagePublicationPlugin> getWebpagePublicationPlugins()

Retrieves all added web page publication plugins. This method is notably used to enumerate possible lifecycles.

Returns:

the map of web page publication plugin

isEnrolledInWCMLifecycle

boolean isEnrolledInWCMLifecycle(javax.jcr.Node node)
                          throws NotInPublicationLifecycleException,
                                 Exception

Checks if is enrolled in wcm lifecycle.

Parameters:

node - the node

Returns:

true, if is enrolled in wcm lifecycle

Throws:

NotInPublicationLifecycleException - the not in publication lifecycle exception

Exception - the exception

enrollNodeInLifecycle

void enrollNodeInLifecycle(javax.jcr.Node node,
                           String lifecycleName)
                    throws Exception

Enroll in a web page publication lifecycle. The method will be retrieve the web page publication lifecycle by lifecycle name and enroll to lifecycle

Parameters:

node - the node

lifecycleName - the lifecycle name

Throws:

Exception - the exception

enrollNodeInLifecycle

void enrollNodeInLifecycle(javax.jcr.Node node,
                           String siteName,
                           String remoteUser)
                    throws Exception

Enroll this node in the default publication lifecycle. Depending on implementation, the default lifecycle could be based on : - lifecycle per site (site provided as a parameter) - lifecycle per author (remoteUser provided as a parameter) - lifecycle per content type (based on the node primary nodetype or its jcr path)

Parameters:

node -

siteName -

remoteUser -

Throws:

Exception

unsubcribeLifecycle

void unsubcribeLifecycle(javax.jcr.Node node)
                  throws NotInPublicationLifecycleException,
                         Exception

Unsubcribe node from a lifecycle plugin. After unsubcribe, the node can enroll to other publication lifecycle

Parameters:

node - the node

Throws:

NotInPublicationLifecycleException - the not in publication lifecycle exception

Exception - the exception

updateLifecyleOnChangeContent

void updateLifecyleOnChangeContent(javax.jcr.Node node,
                                   String siteName,
                                   String remoteUser)
                            throws Exception

Called by create and edit listeners. It allows to update the lifecycle of the content depending of its current state.

Parameters:

node -

siteName -

remoteUser -

Throws:

Exception

See Also:

PostCreateContentEventListener, PostEditContentEventListener

updateLifecyleOnChangeContent

void updateLifecyleOnChangeContent(javax.jcr.Node node,
                                   String siteName,
                                   String remoteUser,
                                   String newState)
                            throws Exception

It allows to update the lifecycle of the content with a new state.

Parameters:

node -

siteName -

remoteUser -

newState -

Throws:

Exception

getContentState

String getContentState(javax.jcr.Node node)
                throws Exception

returns the current state of the content. We consider the publication:currentState property mandatory in all lifecycles.

Parameters:

node -

Returns:

the revision state stored in publication:currentState property

Throws:

Exception