org.exoplatform.services.wcm.publication

Class WebpagePublicationPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.services.ecm.publication.PublicationPlugin

org.exoplatform.services.wcm.publication.WebpagePublicationPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

AuthoringPublicationPlugin

public abstract class WebpagePublicationPlugin
extends PublicationPlugin

Base class of Webpage Publication plugins. Webpage publication plugins implement a publication lifecycle. Each time a new custom lifecycle needs to be defined, a new plugin has to be implemented and registered with the Publication Service.

Field Summary

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
WebpagePublicationPlugin()

Method Summary

Modifier and Type	Method and Description
abstract String	getLifecycleType() Gets the lifecycle type.
abstract List<String>	getListUserNavigationUri(org.exoplatform.portal.config.model.Page page, String remoteUser) Gets the list page navigation uri.
abstract void	updateLifecyleOnChangeContent(javax.jcr.Node node, String remoteUser) Update the lifecycle of the content depending of its current state.
abstract void	updateLifecyleOnChangeContent(javax.jcr.Node node, String remoteUser, String newState) Update the lifecycle of the content depending of its current state.

Methods inherited from class org.exoplatform.services.ecm.publication.PublicationPlugin

addMixin, canAddMixin, changeState, getLifecycleName, getLocalizedAndSubstituteMessage, getNodeLifecycleDesc, getNodeView, getPossibleStates, getStateImage, getStateUI, getUserInfo

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

WebpagePublicationPlugin

public WebpagePublicationPlugin()

Method Detail

updateLifecyleOnChangeContent

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

Update the lifecycle of the content depending of its current state. This method is generally called when the node has been modified (saved).

Parameters:

node - the node

remoteUser - the remote user

Throws:

Exception - the exception

See Also:

PostCreateContentEventListener, PostEditContentEventListener

updateLifecyleOnChangeContent

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

Update the lifecycle of the content depending of its current state. This method is generally called when the node has been modified (saved).

Parameters:

node - the node

remoteUser - the remote user

newState - the new state

Throws:

Exception - the exception

See Also:

PostCreateContentEventListener, PostEditContentEventListener

getLifecycleType

public abstract String getLifecycleType()

Gets the lifecycle type.

Returns:

the lifecycle type

getListUserNavigationUri

public abstract List<String> getListUserNavigationUri(org.exoplatform.portal.config.model.Page page,
                                                      String remoteUser)
                                               throws Exception

Gets the list page navigation uri.

Parameters:

page - the page

remoteUser - the remote user

Returns:

the list page navigation uri

Throws:

Exception - the exception