org.jahia.services.wip

Class WIPService

java.lang.Object

org.jahia.services.wip.WIPService

public class WIPService
extends Object

Work in progress Service Service that handle Wip Information for a given node A WIP Information is: - a status that is one of: "DISABLED" (default value), "ALL_CONTENTS", "LANGUAGES" - languages: list of language codes on witch WIP is set (only used by LANGUAGES status)

Constructor Summary

Constructors

Constructor and Description
WIPService()

Method Summary

Modifier and Type	Method and Description
void	createWipPropertiesOnNewNode(JCRNodeWrapper node, WIPInfo wipInfo) Add work in progress properties on a created node.
WIPInfo	getDefaultWipInfo() Read "wip.checkbox.checked" system property value to get default WIP status.
WIPInfo	getWipInfo(JCRNodeWrapper node) Return work in progress information for the given node
void	saveWipPropertiesIfNeeded(JCRNodeWrapper node, WIPInfo wipInfo) Set the WIP status on the given node according to the given WIPInfo.
void	setPublicationService(JCRPublicationService publicationService)

Methods inherited from class java.lang.Object

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

Constructor Detail

WIPService

public WIPService()

Method Detail

setPublicationService

public void setPublicationService(JCRPublicationService publicationService)

getWipInfo

public WIPInfo getWipInfo(JCRNodeWrapper node)
                   throws javax.jcr.RepositoryException

Return work in progress information for the given node

Parameters:

node - to on witch to get WIP Information

Returns:

WIP Info (status + languages)

Throws:

javax.jcr.RepositoryException

getDefaultWipInfo

public WIPInfo getDefaultWipInfo()

Read "wip.checkbox.checked" system property value to get default WIP status.

Returns:

ALL_CONTENT if enabled

createWipPropertiesOnNewNode

public void createWipPropertiesOnNewNode(JCRNodeWrapper node,
                                         WIPInfo wipInfo)
                                  throws javax.jcr.RepositoryException

Add work in progress properties on a created node. Use this method to set WIP properties on a newly created node

Parameters:

node -

wipInfo -

Throws:

javax.jcr.RepositoryException

saveWipPropertiesIfNeeded

public void saveWipPropertiesIfNeeded(JCRNodeWrapper node,
                                      WIPInfo wipInfo)
                               throws javax.jcr.RepositoryException

Set the WIP status on the given node according to the given WIPInfo. For new node, please use "createWipPropertiesOnNewNode(JCRNodeWrapper node, WIPInfo wipInfo)"

Parameters:

node - where to set the property

wipInfo -

Throws:

javax.jcr.RepositoryException