|
Oracle Fusion Middleware Java API Reference for Oracle ADF Controller 11g Release 2 (11.1.2.2.0) E17480-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskFlowDefinition
Metadata for a bounded task flow definition. Task flow definition is specified using <task-flow-definition> element. In some cases, the definition can extend a template. When a task flow definition extends a template, the TaskFlowDefinition
getter methods provide a combined view of the metadata contained in the task flow definition and the task flow template that it extends.
Method Summary | |
---|---|
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 |
addTaskFlowInputParameter(TaskFlowInputParameter parameter) Adds a new task flow input parameter to a task flow definition. |
DataControlScopeType |
getDataControlScopeType() Specifies data control scope for the task flow. |
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. |
java.lang.String |
getSavePointRestoreFinalizer() Get the save point restore finalizer. |
TaskFlowId |
getTaskFlowId() Gets the task flow's ID. |
java.util.Map<java.lang.String,Outcome> |
getTaskFlowOutcomes() Returns a Map of Outcome definitions keyed by an outcome name. |
TaskFlowReentry |
getTaskFlowReentry() Specifies task flow reentry metadata for a task flow. |
TaskFlowId |
getTemplateId() Gets the task flow ID of a template this task flow is based on. |
TransactionType |
getTransactionType() |
Visibility |
getVisibility() Returns the visibility in formation for this taskflow. |
boolean |
isCritical() Returns true if the task flow is marked as critical. |
boolean |
isTemplate() Returns true, if this task flow metadata represents a template. |
boolean |
isTrain() Task flows can be defined to be trains. |
boolean |
setDefaultActivityId(java.lang.String activityId) Sets the default activity for this bounded task flow. |
boolean |
setTemplateId(TaskFlowId templateId) |
boolean |
setTrain(boolean train) Makes this task flow a train. |
boolean |
setUsePageFragments(boolean usePageFragments) Sets use-page-fragments value for this task flow. |
boolean |
shouldPerformSavePoint() When ADFc task flow is entered, ADFm savepoint can be performed. |
boolean |
usePageFragments() |
Methods inherited from interface oracle.adf.controller.metadata.model.PageFlow |
---|
addActivity, addControlFlowRule, addManagedBean, getActivities, getControlFlowRule, getControlFlowRules, getExceptionHandlerId, getManagedBeans, getSecurity, removeActivity, removeControlFlowRule, removeManagedBean |
Methods inherited from interface oracle.adf.controller.metadata.model.UIInfo |
---|
getDescription, getDisplayName, getLargeIcon, getSmallIcon, getUIInfo, setDescription, setDisplayName, setLargeIcon, setSmallIcon |
Methods inherited from interface oracle.adf.controller.metadata.model.AdfcNode |
---|
getParsingContext, validate |
Methods inherited from interface oracle.adf.controller.metadata.model.IdHolder |
---|
getIdAttribute, setIdAttribute |
Methods inherited from interface oracle.adf.controller.metadata.model.NodeHolder |
---|
getNode |
Method Detail |
---|
TaskFlowId getTaskFlowId()
TaskFlowId getTemplateId()
boolean setTemplateId(TaskFlowId templateId)
boolean isTemplate()
ActivityId getDefaultActivityId()
java.util.Map<java.lang.String,Outcome> getTaskFlowOutcomes()
Map
of Outcome
definitions keyed by an outcome name.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.DataControlScopeType getDataControlScopeType()
TaskFlowReentry getTaskFlowReentry()
TaskFlowReentry
java.lang.String getFinalizer()
finalize()
.java.lang.String getSavePointRestoreFinalizer()
java.lang.String getInitializer()
boolean isTrain()
boolean isCritical()
boolean usePageFragments()
TransactionType getTransactionType()
TransactionType
boolean shouldPerformSavePoint()
Visibility getVisibility()
Visibility
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 #createView
.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 #createView
.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 setUsePageFragments(boolean usePageFragments)
usePageFragments
- the new use-page-fragments valueboolean setTrain(boolean train)
train
- the new value for the train settingboolean addTaskFlowInputParameter(TaskFlowInputParameter parameter)
parameter
- the new task flow input parameter
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Controller 11g Release 2 (11.1.2.2.0) E17480-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |