oracle.adf.controller.metadata.model

Interface TaskFlowDefinition

All Superinterfaces:

AdfcNode, IdHolder, NodeHolder, PageFlow, PageFlowBase, TaskFlowDefinitionBase, UIInfo

public interface TaskFlowDefinition
extends TaskFlowDefinitionBase, 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

Modifier and Type	Method and Description
DataControlScopeType	getDataControlScopeType() Specifies data control scope for the task flow.
java.lang.String	getSavePointRestoreFinalizer() Get the save point restore finalizer.
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	setCritical(boolean critical) If critical setting for the task flow matches the critical value, a warning will be logged.
boolean	setDataControlScopeType(DataControlScopeType type) Sets the data control scope for the task flow to shared or isolated.
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	setPerformSavePoint(boolean savePoint) Changes no-save-point setting for the task flow.
boolean	setSavePointRestoreFinalizer(java.lang.String finalizer) Adds or removes save point restore finalizer to this task flow.
boolean	setTaskFlowReentry(TaskFlowReentry reentry) Sets or removes task flow reentry for the back button behavior.
boolean	setTemplateId(TaskFlowId templateId)
boolean	setTrain(boolean train) Makes this task flow a train.
boolean	setTransactionType(TransactionType type) Sets a new transaction type for the task flow definition.
boolean	setUsePageFragments(boolean usePageFragments) Sets use-page-fragments value for this task flow.
boolean	setVisibility(Visibility visibility) Adds, removes, or modifies visibility 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.TaskFlowDefinitionBase

addActivityAfter, addActivityBefore, addReturnValue, addTaskFlowInputParameter, getDefaultActivityId, getFinalizer, getInitializer, getInputParameters, getReturnValues, getTaskFlowId, removeReturnValue, removeTaskFlowInputParameter, setInitializer

Methods inherited from interface oracle.adf.controller.metadata.model.PageFlow

addControlFlowRule, getControlFlowRule, getControlFlowRules, getExceptionHandlerId, getSecurity, removeControlFlowRule, setExceptionHandlerId

Methods inherited from interface oracle.adf.controller.metadata.model.PageFlowBase

addActivity, addManagedBean, getActivities, getManagedBeans, getViewActivity, removeActivity, 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

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

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.

getDataControlScopeType

DataControlScopeType getDataControlScopeType()

Specifies data control scope for the task flow. If specified, it must be one of:

• isolated
• shared

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:

• reentry-allowed
• reentry-not-allowed
• reentry-outcome-dependent

If not specified in the metadata, reentry allowed for any activity will be assumed.

Returns:

TaskFlowReentry

See Also:

TaskFlowReentry

getSavePointRestoreFinalizer

java.lang.String getSavePointRestoreFinalizer()

Get the save point restore finalizer.

Returns:

the save point restore finalizer.

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

setDefaultActivityId

boolean setDefaultActivityId(java.lang.String activityId)

Sets the default activity for this bounded task flow.

Specified by:

setDefaultActivityId in interface TaskFlowDefinitionBase

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

setCritical

boolean setCritical(boolean critical)

If critical setting for the task flow matches the critical value, a warning will be logged. If critical is true, a critical flag will be added to the task flow definition. If critical is false, critical flag will be removed.

Parameters:

critical - the new value for the critical flag

Returns:

true, if critical flag was successfully added or removed

setDataControlScopeType

boolean setDataControlScopeType(DataControlScopeType type)

Sets the data control scope for the task flow to shared or isolated. If type matches already specified value, a warning will be logged. If type is null, data control scope element will be removed from the task flow definition.

Parameters:

type - the new value for the data control scope

Returns:

true, if data control scope was successfully set

setFinalizer

boolean setFinalizer(java.lang.String finalizer)

Sets or removes task flow finalizer.

Specified by:

setFinalizer in interface TaskFlowDefinitionBase

Parameters:

finalizer - the new value for the task flow finalizer, or null, if finalizer should be removed.

Returns:

true, if the finalizer was successfully set or removed

setSavePointRestoreFinalizer

boolean setSavePointRestoreFinalizer(java.lang.String finalizer)

Adds or removes save point restore finalizer to this task flow.

Parameters:

finalizer - the new value of the save point finalizer

Returns:

true, if save point finalizer was successfully added or removed

setTaskFlowReentry

boolean setTaskFlowReentry(TaskFlowReentry reentry)

Sets or removes task flow reentry for the back button behavior. If new reentry matches the existing taks flow reentry, a warning will be logged.

Parameters:

reentry - the new reentry value

Returns:

true, if reentry was successfully added or removed

setTransactionType

boolean setTransactionType(TransactionType type)

Sets a new transaction type for the task flow definition. If type is null, transaction type will be removed.

Parameters:

type - a new transaction type

Returns:

true, if transaction type was successfully added or removed

setPerformSavePoint

boolean setPerformSavePoint(boolean savePoint)

Changes no-save-point setting for the task flow. If savePoint is false, no-save-point will be added, otherwise it will be removed. If savePoint matches the task flow definition value, a warning will be logged.

Parameters:

savePoint - a new value for should perform save point setting

Returns:

true, if no-save-point was successfully added or removed

setVisibility

boolean setVisibility(Visibility visibility)

Adds, removes, or modifies visibility for this task flow. If visibility matches task flow's visibility, a warning will be logged.

Parameters:

visibility - the new value for visibility

Returns:

true, if operation was succesffull.