public interface TaskFlowDefinitionBase
Modifier and Type | Method and Description |
---|---|
boolean |
addActivityAfter(java.lang.String activityId,
java.lang.String type,
Activity metadata,
Activity sibling)
Inserts a new activity definition into a task flow after a specified
sibling activity.
|
boolean |
addActivityBefore(java.lang.String activityId,
java.lang.String type,
Activity metadata,
Activity sibling)
Inserts a new activity definition into a task flow after a specified
sibling activity.
|
boolean |
addReturnValue(NamedParameter parameter)
Adds a return value definition to the task flow.
|
boolean |
addTaskFlowInputParameter(TaskFlowInputParameter parameter)
Adds a new task flow input parameter to a task flow definition.
|
ActivityId |
getDefaultActivityId()
Returns the ID of the default activity in this task flow.
|
java.lang.String |
getFinalizer()
A task flow can specify a method that will get called to clean up any
resources allocated by the task flow's activities.
|
java.lang.String |
getInitializer()
Analogous to finalizer: a method expresion for a method that
gets called when a task flow is entered, after its input parameters
have been evaluated, but before default activity is executed.
|
java.util.Map<java.lang.String,TaskFlowInputParameter> |
getInputParameters()
Returns a
Map of input parameters for this task flow. |
java.util.Map<java.lang.String,NamedParameter> |
getReturnValues()
Returns a
Map of output parameters for this task flow. |
TaskFlowId |
getTaskFlowId()
Gets the task flow's ID.
|
boolean |
removeReturnValue(NamedParameter parameter)
Removes the return value definition with a matching name from the task flow.
|
boolean |
removeTaskFlowInputParameter(TaskFlowInputParameter parameter)
Removes a specified input parameter definition from the task flow.
|
boolean |
setDefaultActivityId(java.lang.String activityId)
Sets the default activity for this bounded task flow.
|
boolean |
setFinalizer(java.lang.String finalizer)
Sets or removes task flow finalizer.
|
boolean |
setInitializer(java.lang.String initializer)
Sets or removes task flow initializer.
|
TaskFlowId getTaskFlowId()
ActivityId getDefaultActivityId()
java.util.Map<java.lang.String,TaskFlowInputParameter> getInputParameters()
Map
of input parameters for this task flow.java.util.Map<java.lang.String,NamedParameter> getReturnValues()
Map
of output parameters for this task flow.java.lang.String getFinalizer()
finalize()
.java.lang.String getInitializer()
boolean addActivityAfter(java.lang.String activityId, java.lang.String type, Activity metadata, Activity sibling)
activityId
- activity id for a new activity, for example, "view1"type
- activity type, for example, ActivityType.VIEWmetadata
- the metadata for this activity. For a view activity,
it can be created by calling AdfcElementFactory.createView(java.lang.String)
.sibling
- the metadata for an activity in a task flow that the new activity
should be inserted relative to.ActivityType
boolean addActivityBefore(java.lang.String activityId, java.lang.String type, Activity metadata, Activity sibling)
activityId
- activity id for a new activity, for example, "view1"type
- activity type, for example, ActivityType.VIEWmetadata
- the metadata for this activity. For a view activity,
it can be created by calling AdfcElementFactory.createView(java.lang.String)
.sibling
- the metadata for an activity in a task flow that the new activity
should be inserted relative to.ActivityType
boolean setDefaultActivityId(java.lang.String activityId)
activityId
- the default activity id. Cannot be null.boolean addTaskFlowInputParameter(TaskFlowInputParameter parameter)
parameter
- the new task flow input parameterboolean removeTaskFlowInputParameter(TaskFlowInputParameter parameter)
parameter
- an input parameter to remove, must not be nullboolean setFinalizer(java.lang.String finalizer)
finalizer
- the new value for the task flow finalizer, or null, if finalizer should be removed.boolean setInitializer(java.lang.String initializer)
initializer
- the new value for the task flow initializer, or null, if finalizer should be removed.boolean addReturnValue(NamedParameter parameter)
parameter
- new return value, must not be nullboolean removeReturnValue(NamedParameter parameter)
parameter
- return value to be removed