public interface TaskFlowCall extends Activity, TrainStopContainer
Modifier and Type | Method and Description |
---|---|
boolean |
addAfterListener(java.lang.String listener)
Adds an expression representing an after listener to the task flow call.
|
boolean |
addBeforeListener(java.lang.String listener)
Adds an expression representing a before listener to the task flow call.
|
boolean |
addInputParameter(ValueMapping input)
Adds a new input parameter definition to this task flow call.
|
boolean |
addReturnValue(ValueMapping output)
Adds a new return value definition to this task flow call.
|
java.lang.String |
getAfterListener() |
java.lang.String |
getBeforeListener() |
DialogDisplayType |
getDialogDisplayType() |
java.lang.String |
getDialogReturnValue()
Get the name of the task flow return value that is the special dialog return value.
|
java.lang.String |
getDynamicTaskFlowDefinitionIdExpression() |
java.lang.String |
getInputParameterMapExpression()
For dynamic task flow calls, input paramters can be specified in
a map.
|
java.util.Map<java.lang.String,ValueMapping> |
getInputParameters()
Get the input parameter mappings.
|
java.lang.String |
getRemoteAppUrl()
Get the URL of the remote web application in which to invoke the task flow.
|
java.util.Map<java.lang.String,ValueMapping> |
getReturnValues()
Get the return value mappings.
|
TaskFlowId |
getTaskFlowDefinitionId()
Get the ID of the task flow defintion this activity calls.
|
java.util.List<TaskFlowId> |
getTaskFlowHints() |
boolean |
isDynamic() |
boolean |
removeInputParameter(ValueMapping input)
Removes an input parameter definition from this task flow call.
|
boolean |
removeReturnValue(ValueMapping output)
Removes a return value definition from this task flow call.
|
boolean |
runAsDialog()
Is this task flow called as a dialog task flow?
|
boolean |
setDialogDisplayType(DialogDisplayType type)
Adds a specified dialog display type to the definition of
run-as-dialog element.
|
boolean |
setDialogReturnValue(java.lang.String returnValue)
Adds a specified dialog return value to the definition of
run-as-dialog element.
|
boolean |
setDynamicTaskFlowDefinitionIdExpression(java.lang.String expression)
Sets the dynamic task flow reference for this task flow call activity.
|
boolean |
setInputParameterMap(java.lang.String expression)
Adds or removes input-parameter-map expression to the task flow call definition.
|
boolean |
setRemoteAppUrl(java.lang.String expression)
Sets the remote application url for this task flow call.
|
boolean |
setTaskFlowDefinitionId(TaskFlowId id)
Sets the task flow reference for this task flow call activity.
|
getId, getMetadataObject, getType
getDescription, getDisplayName, getLargeIcon, getSmallIcon, getUIInfo, setDescription, setDisplayName, setLargeIcon, setSmallIcon
getParsingContext, validate
getIdAttribute, setIdAttribute
getNode
getTrainStop, setTrainStop
boolean isDynamic()
TaskFlowId getTaskFlowDefinitionId()
java.lang.String getDynamicTaskFlowDefinitionIdExpression()
TaskFlowId
or null, if this task flow activity is staticjava.util.List<TaskFlowId> getTaskFlowHints()
java.util.Map<java.lang.String,ValueMapping> getInputParameters()
java.lang.String getInputParameterMapExpression()
java.util.Map<java.lang.String,ValueMapping> getReturnValues()
boolean runAsDialog()
true
indicates it is run as a dialog task flow,false
indicates it is not run as a dialog task flow.java.lang.String getDialogReturnValue()
DialogDisplayType getDialogDisplayType()
java.lang.String getRemoteAppUrl()
null
if the
task flow is to be invoked in the local web application.java.lang.String getBeforeListener()
java.lang.String getAfterListener()
boolean addAfterListener(java.lang.String listener)
listener
- the EL expression representing the after listener.boolean addBeforeListener(java.lang.String listener)
listener
- the EL expression representing the before listener.boolean setTaskFlowDefinitionId(TaskFlowId id)
id
- the task flow id of the task flow definition for this task flow call.
Cannot be null or empty.boolean setDynamicTaskFlowDefinitionIdExpression(java.lang.String expression)
expression
- the EL that evaluates to the task flow id.boolean setRemoteAppUrl(java.lang.String expression)
expression
- an EL expression representing the remove app url or null.boolean addInputParameter(ValueMapping input)
input
- the new input parameter definitionboolean removeInputParameter(ValueMapping input)
input
- the input parameter definition to removeboolean setInputParameterMap(java.lang.String expression)
expression
- the EL representing input parameter map, or null, if the map
should be removed.boolean addReturnValue(ValueMapping output)
output
- the new output parameter definition.boolean removeReturnValue(ValueMapping output)
output
- the return value definition to removeboolean setDialogDisplayType(DialogDisplayType type)
type
- the new dialog display type.boolean setDialogReturnValue(java.lang.String returnValue)
returnValue
- the new dialog return value.