Package com.comalatech.workflow.model
Interface Workflow
-
public interface Workflow
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Workflow.State
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description String
getDescription()
String
getErrorMessage()
String
getLabelName()
Deprecated.Since Workflows 4.9 a workflow can be associated with multiple labels, this method will only return the first one.List<String>
getLabelNames()
The labels associated with this worklow.String
getName()
List<String>
getStateNames()
String
getWorkflowMarkup()
List<? extends WorkflowParameter>
getWorkflowParameters()
List<Workflow.State>
getWorkflowStates()
boolean
isActive()
boolean
isInvertLabels()
Is the label condition inverted, ie, workflow is active for pages that don't have the labels ingetLabelNames()
-
-
-
Method Detail
-
getName
String getName()
- Returns:
- the workflow's name
-
getWorkflowMarkup
String getWorkflowMarkup()
- Returns:
- the workflow's markup
-
getWorkflowStates
List<Workflow.State> getWorkflowStates()
-
getLabelName
String getLabelName()
Deprecated.Since Workflows 4.9 a workflow can be associated with multiple labels, this method will only return the first one. UsegetLabelNames()
instead.- Returns:
- the label associated to this workflow (i.e. content containing this label will be subject this this workflow). Null if none.
-
getLabelNames
List<String> getLabelNames()
The labels associated with this worklow. By default a workflow will only be active if a page has at least one of the labels specified. If the invert labels condition is set (isInvertLabels()
), a workflow will be active on a page if that page has none of the labels specified.- Returns:
- the labels associated with the workflow
- Since:
- 1.11
-
isInvertLabels
boolean isInvertLabels()
Is the label condition inverted, ie, workflow is active for pages that don't have the labels ingetLabelNames()
- Returns:
- true and label condition is inverted.
- Since:
- 1.11
-
isActive
boolean isActive()
- Returns:
- true if the workflow is active.
-
getErrorMessage
String getErrorMessage()
- Returns:
- localised plain text error message if workflow markup is invalid
-
getDescription
String getDescription()
- Returns:
- the description of this workflow
-
getWorkflowParameters
List<? extends WorkflowParameter> getWorkflowParameters()
-
-