Package com.adobe.granite.workflow

Interface PayloadMap

public interface PayloadMap

The PayloadMap is listening to workflow events (started, terminated, completed and manages a payload map (only JCR_PATH payloads) in order to enable quick lookup for nodes/resources which might be subject of a workflow.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_JCR_PATH
static final String	TYPE_JCR_UUID

Method Summary

Modifier and Type	Method	Description
List<Workflow>	getWorkflowInstances(String path, boolean excludeSystemWorkflows)	All Workflow instances are returned.
boolean	isInWorkflow(String path, boolean excludeSystemWorkflows)	Checks whether a JCR_PATHbased path is subject of a running Workflow instance.

Field Details

TYPE_JCR_PATH

static final String TYPE_JCR_PATH

See Also:

• Constant Field Values

TYPE_JCR_UUID

static final String TYPE_JCR_UUID

See Also:

• Constant Field Values

Method Details

isInWorkflow

boolean isInWorkflow(String path,
 boolean excludeSystemWorkflows)

Checks whether a JCR_PATHbased path is subject of a running Workflow instance.

Parameters:

path - path to check

excludeSystemWorkflows - set to true to exclude system workflows from the evaluation

Returns:

true if JCR_PATHbased path is subject of a running workflow

getWorkflowInstances

List<Workflow> getWorkflowInstances(String path,
 boolean excludeSystemWorkflows)

All Workflow instances are returned.

Parameters:

path - node path

excludeSystemWorkflows - set to true to exclude system workflows from the evaluation

Returns:

the list of Workflow instances or an empty list is returned