Oracle Fusion Middleware Java API Reference for Oracle ADF Controller
11g Release 1 (11.1.1.7.0)

E10651-08

oracle.adf.controller.metadata.model
Interface TaskFlowDefinition

All Superinterfaces:
AdfcNode, IdHolder, NodeHolder, PageFlow, UIInfo

public interface TaskFlowDefinition
extends PageFlow

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

getTaskFlowId

TaskFlowId getTaskFlowId()
Gets the task flow's ID.

Returns:
task flow ID.

getTemplateId

TaskFlowId getTemplateId()
Gets the task flow ID of a template this task flow is based on.

Returns:
taks flow ID or null, if the task flow is not based on a template.

setTemplateId

boolean setTemplateId(TaskFlowId templateId)

isTemplate

boolean isTemplate()
Returns true, if this task flow metadata represents a template.

Returns:
true if this is a task flow template, false otherwise

getDefaultActivityId

ActivityId getDefaultActivityId()
Returns the ID of the default activity in this task flow. The default activity is executed first when the task flow is entered.

Returns:
the ID of the default activity.

getTaskFlowOutcomes

java.util.Map<java.lang.String,Outcome> getTaskFlowOutcomes()
Returns a Map of Outcome definitions keyed by an outcome name.

Returns:
map of all valid logical outcomes of this task flow.

getInputParameters

java.util.Map<java.lang.String,TaskFlowInputParameter> getInputParameters()
Returns a Map of input parameters for this task flow.

Returns:
input parameter map keyed by parameter name

getReturnValues

java.util.Map<java.lang.String,NamedParameter> getReturnValues()
Returns a Map of output parameters for this task flow.

Returns:
output parameter map keyed by parameter name

getDataControlScopeType

DataControlScopeType getDataControlScopeType()
Specifies data control scope for the task flow. If specified, it must be one of: If not specified, data control scope is assumed to be isolated.

Returns:
data control scope type.

getTaskFlowReentry

TaskFlowReentry getTaskFlowReentry()
Specifies task flow reentry metadata for a task flow. If specified, task flow reentry must be one of: If not specified in the metadata, reentry allowed for any activity will be assumed.

Returns:
TaskFlowReentry
See Also:
TaskFlowReentry

getFinalizer

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. This method will be called regardless whether task flow exited normally or due to an exception. Task flow finalizer is analogous to Java finalize().

Returns:
String method EL expression for the task flow finalizer.

getSavePointRestoreFinalizer

java.lang.String getSavePointRestoreFinalizer()
Get the save point restore finalizer.

Returns:
the save point restore finalizer.

getInitializer

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. Initializer might be required in cases where application logic has to be performed regardless of whether a task flow is entered via a task flow call activity or as a result of back button navigation.

Returns:
String method EL expression for the task flow initializer

isTrain

boolean isTrain()
Task flows can be defined to be trains.

Returns:
true, if this task flow represent a train, false otherwhise

isCritical

boolean isCritical()
Returns true if the task flow is marked as critical.

Returns:
true if the task flow is critical.

usePageFragments

boolean usePageFragments()
Returns:
true, if this task flow should use page fragments in its view activities

getTransactionType

TransactionType getTransactionType()
Returns:
a TransactionType for this task flow, or null
See Also:
TransactionType

shouldPerformSavePoint

boolean shouldPerformSavePoint()
When ADFc task flow is entered, ADFm savepoint can be performed.

Returns:
true or false, indicating whether a save point should be performed

getVisibility

Visibility getVisibility()
Returns the visibility in formation for this taskflow.

Returns:
the visibility information for this taskflow.
See Also:
Visibility

addActivityAfter

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. This method allows to add a new train stop activity into a train task flow relative to an existing train stop.

Parameters:
activityId - activity id for a new activity, for example, "view1"
type - activity type, for example, ActivityType.VIEW
metadata - 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.
Returns:
true, if activity was successfully added, false otherwise
See Also:
ActivityType

addActivityBefore

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. This method allows to add a new train stop activity into a train task flow relative to an existing train stop.

Parameters:
activityId - activity id for a new activity, for example, "view1"
type - activity type, for example, ActivityType.VIEW
metadata - 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.
Returns:
true, if activity was successfully added, false otherwise
See Also:
ActivityType

setDefaultActivityId

boolean setDefaultActivityId(java.lang.String activityId)
Sets the default activity for this bounded task flow.

Parameters:
activityId - the default activity id. Cannot be null.
Returns:
true, if default activity id was successfully set, false otherwise.

setUsePageFragments

boolean setUsePageFragments(boolean usePageFragments)
Sets use-page-fragments value for this task flow.

Parameters:
usePageFragments - the new use-page-fragments value
Returns:
true, if use-page-fragments was successfully set, false otherwise

setTrain

boolean setTrain(boolean train)
Makes this task flow a train.

Parameters:
train - the new value for the train setting
Returns:
true, if train was successfully set, false otherwise

addTaskFlowInputParameter

boolean addTaskFlowInputParameter(TaskFlowInputParameter parameter)
Adds a new task flow input parameter to a task flow definition.

Parameters:
parameter - the new task flow input parameter
Returns:
true, if parameter was successfully addded.

Oracle Fusion Middleware Java API Reference for Oracle ADF Controller
11g Release 1 (11.1.1.7.0)

E10651-08

Copyright © 1997, 2013, Oracle. All rights reserved.