@ProviderType 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() |
WorkflowNode |
createNode(String title,
String type,
String description) |
WorkflowTransition |
createTransition() |
WorkflowTransition |
createTransition(WorkflowNode from,
WorkflowNode to,
String rule) |
VariableTemplate |
createVariableTemplate(String name,
String dataType) |
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 . |
Map<String,VariableTemplate> |
getVariableTemplates() |
String |
getVersion()
Returns the version of the
WorkflowModel . |
void |
setDescription(String description)
Sets the description of the
WorkflowModel . |
void |
setEndNode(WorkflowNode node) |
void |
setRootNode(WorkflowNode node) |
void |
setTitle(String title)
Sets the title of the
WorkflowModel . |
void |
validate()
Validates the model.
|
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 createNode(String title, String type, String description)
title
- the titletype
- the typedescription
- the descriptionvoid setRootNode(WorkflowNode node)
node
- the workflow nodevoid setEndNode(WorkflowNode node)
node
- the workflow nodeWorkflowNode 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 createTransition(WorkflowNode from, WorkflowNode to, String rule)
from
- the workflow node to begin the transition withto
- the workflow node to end the transition withrule
- the rulevoid validate() throws ValidationException
ValidationException
- in case the validation failsMap<String,VariableTemplate> getVariableTemplates()
Map
with keys as variables' names and values as VariableTemplate
s .VariableTemplate createVariableTemplate(String name, String dataType)
name
- the name of the variabledataType
- the type of the variable in java fully qualified class name formatCopyright © 2010 - 2020 Adobe. All Rights Reserved