com.day.cq.workflow.model

Interface WorkflowModel

All Superinterfaces:

HasMetaData

public interface WorkflowModel
extends HasMetaData

WorkflowModel represents a model/definition of a workflow. It provides methods for retrieving the entities of the model like WorkflowNodes and WorkflowTransitions as well as common model attributes like name, description or version.

Method Summary

Modifier and Type	Method and Description
WorkflowNode	createNode() Creates and returns a WorkflowNode
WorkflowNode	createNode(java.lang.String title, java.lang.String type, java.lang.String description) Creates and returns a WorkflowNode
WorkflowTransition	createTransition() Creates and returns a WorkflowTransition
WorkflowTransition	createTransition(WorkflowNode from, WorkflowNode to, java.lang.String rule) Creates and returns a WorkflowTransition
java.lang.String	getDescription() Returns the description of the WorkflowModel.
WorkflowNode	getEndNode() Returns the end WorkflowNode.
java.lang.String	getId() Returns the ID of the WorkflowModel.
WorkflowNode	getNode(java.lang.String id) Returns the WorkflowNode with the given id
java.util.List<WorkflowNode>	getNodes() Returns the list of WorkflowNodes contained by the WorkflowModel.
WorkflowNode	getRootNode() Returns the root/start WorkflowNode.
java.lang.String	getTitle() Returns the title of the WorkflowModel.
java.util.List<WorkflowTransition>	getTransitions() Returns the list of WorkflowTransitions contained by the WorkflowModel.
java.lang.String	getVersion() Returns the version of the WorkflowModel.
void	setDescription(java.lang.String description) Sets the description of the WorkflowModel.
void	setEndNode(WorkflowNode node) Sets the end node of the WorkflowModel.
void	setRootNode(WorkflowNode node) Sets the root node of the WorkflowModel.
void	setTitle(java.lang.String title) Sets the title of the WorkflowModel.
void	validate() Validates the model.

Methods inherited from interface com.day.cq.workflow.HasMetaData

getMetaData, getMetaDataMap

Method Detail

getId

java.lang.String getId()

Returns the ID of the WorkflowModel.

Returns:

The ID of the WorkflowModel.

getTitle

java.lang.String getTitle()

Returns the title of the WorkflowModel.

Returns:

The title of the WorkflowModel.

setTitle

void setTitle(java.lang.String title)

Sets the title of the WorkflowModel.

Parameters:

title - The new title of the WorkflowModel.

getDescription

java.lang.String getDescription()

Returns the description of the WorkflowModel.

Returns:

The description of the WorkflowModel.

setDescription

void setDescription(java.lang.String description)

Sets the description of the WorkflowModel.

Parameters:

description - The new description of the WorkflowModel.

getVersion

java.lang.String getVersion()

Returns the version of the WorkflowModel.

Returns:

The version of the WorkflowModel.

getNodes

java.util.List<WorkflowNode> getNodes()

Returns the list of WorkflowNodes contained by the WorkflowModel.

Returns:

The list of WorkflowNodes of the WorkflowModel.

createNode

WorkflowNode createNode()

Creates and returns a WorkflowNode

Returns:

The WorkflowNode created

createNode

WorkflowNode createNode(java.lang.String title,
                        java.lang.String type,
                        java.lang.String description)

Creates and returns a WorkflowNode

Parameters:

title - Title of node created

type - Type of node created

description - Description of node created

Returns:

The WorkflowNode created

setRootNode

void setRootNode(WorkflowNode node)

Sets the root node of the WorkflowModel.

Parameters:

node - The root node of the WorkflowModel.

setEndNode

void setEndNode(WorkflowNode node)

Sets the end node of the WorkflowModel.

Parameters:

node - The end node of the WorkflowModel.

getNode

WorkflowNode getNode(java.lang.String id)

Returns the WorkflowNode with the given id

Parameters:

id - The ID of the WorkflowNode.

Returns:

The WorkflowNode or null if not found.

getRootNode

WorkflowNode getRootNode()

Returns the root/start WorkflowNode.

Returns:

The root WorkflowNode.

getEndNode

WorkflowNode getEndNode()

Returns the end WorkflowNode.

Returns:

The end WorkflowNode.

getTransitions

java.util.List<WorkflowTransition> getTransitions()

Returns the list of WorkflowTransitions contained by the WorkflowModel.

Returns:

The list of WorkflowTransitions of the WorkflowModel.

createTransition

WorkflowTransition createTransition()

Creates and returns a WorkflowTransition

Returns:

The WorkflowTransition created

createTransition

WorkflowTransition createTransition(WorkflowNode from,
                                    WorkflowNode to,
                                    java.lang.String rule)

Creates and returns a WorkflowTransition

Parameters:

from - The from range WorkflowNode

to - The to range WorkflowNode

rule - The rule String

Returns:

The WorkflowTransition created

validate

void validate()
       throws ValidationException

Validates the model.

Throws:

ValidationException - ValidationException in case an error occurs