org.hippoecm.repository.api

Class DocumentWorkflowAction

java.lang.Object

org.hippoecm.repository.api.DocumentWorkflowAction

All Implemented Interfaces:

ActionAware, WorkflowAction

public class DocumentWorkflowAction
extends Object
implements ActionAware, WorkflowAction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentWorkflowAction.DocumentPayloadKey

Nested classes/interfaces inherited from interface org.hippoecm.repository.api.WorkflowAction

WorkflowAction.PayloadKey

Constructor Summary

Constructors

Constructor and Description
DocumentWorkflowAction(String action)
DocumentWorkflowAction(String action, boolean mutates)

Method Summary

Modifier and Type	Method and Description
static DocumentWorkflowAction	acceptRequest()
DocumentWorkflowAction	addEventPayload(String key, Object value)
DocumentWorkflowAction	addEventPayload(WorkflowAction.PayloadKey key, Object value)
static DocumentWorkflowAction	branch()
static DocumentWorkflowAction	cancelRequest()
static DocumentWorkflowAction	checkModified()
static DocumentWorkflowAction	checkoutBranch()
static DocumentWorkflowAction	commitEditableInstance()
static DocumentWorkflowAction	copy()
static DocumentWorkflowAction	delete()
static DocumentWorkflowAction	depublish()
static DocumentWorkflowAction	depublishBranch()
static DocumentWorkflowAction	disposeEditableInstance()
String	getAction()
static DocumentWorkflowAction	getBranch()
Map<String,Object>	getEventPayload()
String	getRequestIdentifier()
boolean	isMutates()
static DocumentWorkflowAction	listBranches()
static DocumentWorkflowAction	listVersions()
static DocumentWorkflowAction	move()
static DocumentWorkflowAction	none()
static DocumentWorkflowAction	obtainEditableInstance()
static DocumentWorkflowAction	publish()
static DocumentWorkflowAction	publishBranch()
static DocumentWorkflowAction	reintegrateBranch()
static DocumentWorkflowAction	rejectRequest()
static DocumentWorkflowAction	removeBranch()
static DocumentWorkflowAction	rename()
static DocumentWorkflowAction	requestDepublication()
DocumentWorkflowAction	requestIdentifier(String requestIdentifier)
static DocumentWorkflowAction	requestPublication()
static DocumentWorkflowAction	restoreVersion()
static DocumentWorkflowAction	restoreVersionToBranch()
static DocumentWorkflowAction	retrieveVersion()
static DocumentWorkflowAction	unlock()
static DocumentWorkflowAction	version()
static DocumentWorkflowAction	versionRestoreTo()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentWorkflowAction

public DocumentWorkflowAction(String action)

DocumentWorkflowAction

public DocumentWorkflowAction(String action,
                              boolean mutates)

Method Detail

unlock

public static DocumentWorkflowAction unlock()

publish

public static DocumentWorkflowAction publish()

checkModified

public static DocumentWorkflowAction checkModified()

obtainEditableInstance

public static DocumentWorkflowAction obtainEditableInstance()

commitEditableInstance

public static DocumentWorkflowAction commitEditableInstance()

disposeEditableInstance

public static DocumentWorkflowAction disposeEditableInstance()

requestDepublication

public static DocumentWorkflowAction requestDepublication()

requestPublication

public static DocumentWorkflowAction requestPublication()

delete

public static DocumentWorkflowAction delete()

rename

public static DocumentWorkflowAction rename()

copy

public static DocumentWorkflowAction copy()

move

public static DocumentWorkflowAction move()

depublish

public static DocumentWorkflowAction depublish()

cancelRequest

public static DocumentWorkflowAction cancelRequest()

acceptRequest

public static DocumentWorkflowAction acceptRequest()

rejectRequest

public static DocumentWorkflowAction rejectRequest()

version

public static DocumentWorkflowAction version()

versionRestoreTo

public static DocumentWorkflowAction versionRestoreTo()

restoreVersion

public static DocumentWorkflowAction restoreVersion()

restoreVersionToBranch

public static DocumentWorkflowAction restoreVersionToBranch()

listVersions

public static DocumentWorkflowAction listVersions()

retrieveVersion

public static DocumentWorkflowAction retrieveVersion()

listBranches

public static DocumentWorkflowAction listBranches()

branch

public static DocumentWorkflowAction branch()

getBranch

public static DocumentWorkflowAction getBranch()

checkoutBranch

public static DocumentWorkflowAction checkoutBranch()

reintegrateBranch

public static DocumentWorkflowAction reintegrateBranch()

publishBranch

public static DocumentWorkflowAction publishBranch()

depublishBranch

public static DocumentWorkflowAction depublishBranch()

removeBranch

public static DocumentWorkflowAction removeBranch()

none

public static DocumentWorkflowAction none()

getRequestIdentifier

public String getRequestIdentifier()

requestIdentifier

public DocumentWorkflowAction requestIdentifier(String requestIdentifier)

getEventPayload

public Map<String,Object> getEventPayload()

addEventPayload

public DocumentWorkflowAction addEventPayload(WorkflowAction.PayloadKey key,
                                              Object value)

addEventPayload

public DocumentWorkflowAction addEventPayload(String key,
                                              Object value)

getAction

public String getAction()

Specified by:

getAction in interface ActionAware

isMutates

public boolean isMutates()