public interface WorkflowModel extends HasMetaData
WorkflowModel
represents a model/definition of a workflow.
It provides methods for retrieving the entities of the model like
WorkflowNode
s and
WorkflowTransition
s as well as common model attributes
like name, description or version.Modifier and Type | Method and Description |
---|---|
WorkflowNode |
createNode()
Creates and returns a
|
WorkflowNode |
createNode(String title,
String type,
String description)
Creates and returns a
|
WorkflowTransition |
createTransition()
Creates and returns a
|
WorkflowTransition |
createTransition(WorkflowNode from,
WorkflowNode to,
String rule)
Creates and returns a
|
String |
getDescription()
Returns the description of the
WorkflowModel . |
WorkflowNode |
getEndNode()
Returns the end
. |
String |
getId()
Returns the ID of the
WorkflowModel . |
WorkflowNode |
getNode(String id)
Returns the
with the given id |
List<WorkflowNode> |
getNodes()
Returns the list of
s contained by the
WorkflowModel . |
WorkflowNode |
getRootNode()
Returns the root/start
. |
String |
getTitle()
Returns the title of the
WorkflowModel . |
List<WorkflowTransition> |
getTransitions()
Returns the list of
s contained by
the WorkflowModel . |
String |
getVersion()
Returns the version of the
WorkflowModel . |
void |
setDescription(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(String title)
Sets the title of the
WorkflowModel . |
void |
validate()
Validates the model.
|
getMetaData, getMetaDataMap
String getId()
WorkflowModel
.WorkflowModel
.String getTitle()
WorkflowModel
.WorkflowModel
.void setTitle(String title)
WorkflowModel
.title
- The new title of the WorkflowModel
.String getDescription()
WorkflowModel
.WorkflowModel
.void setDescription(String description)
WorkflowModel
.description
- The new description of the WorkflowModel
.String getVersion()
WorkflowModel
.WorkflowModel
.List<WorkflowNode> getNodes()
WorkflowNode
s contained by the
WorkflowModel
.WorkflowNode
s of the
WorkflowModel
.WorkflowNode createNode()
WorkflowNode
WorkflowNode
createdWorkflowNode createNode(String title, String type, String description)
WorkflowNode
title
- Title of node createdtype
- Type of node createddescription
- Description of node createdWorkflowNode
createdvoid setRootNode(WorkflowNode node)
WorkflowModel
.node
- The root node of the WorkflowModel
.void setEndNode(WorkflowNode node)
WorkflowModel
.node
- The end node of the WorkflowModel
.WorkflowNode getNode(String id)
WorkflowNode
with the given idid
- The ID of the WorkflowNode
.WorkflowNode
or null if not found.WorkflowNode getRootNode()
WorkflowNode
.WorkflowNode
.WorkflowNode getEndNode()
WorkflowNode
.WorkflowNode
.List<WorkflowTransition> getTransitions()
WorkflowTransition
s contained by
the WorkflowModel
.WorkflowTransition
s of the
WorkflowModel
.WorkflowTransition createTransition()
WorkflowTransition
WorkflowTransition
createdWorkflowTransition createTransition(WorkflowNode from, WorkflowNode to, String rule)
WorkflowTransition
from
- The from range WorkflowNode
to
- The to range WorkflowNode
rule
- The rule String
WorkflowTransition
createdvoid validate() throws ValidationException
ValidationException
- ValidationException
in case an error occursCopyright © 2010 - 2020 Adobe. All Rights Reserved