Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Controller
11g Release 2 (11.1.2.3.0)

E17480-04


oracle.adf.controller.metadata.model
Interface ControlFlowRule

All Superinterfaces:
AdfcNode, IdHolder, NodeHolder, UIInfo

public interface ControlFlowRule
extends UIInfo

An instance of a control flow rule.


Method Summary
 boolean addControlFlowCase(ControlFlowCase cfCase)
          Adds a new control flow case to this control flow rule.
 java.util.Map<java.lang.String,ControlFlowCase> getActionAndOutcomeCases()
           
 java.util.Map<java.lang.String,ControlFlowCase> getActionOnlyCases()
           
 ControlFlowCase getControlFlowCase(java.lang.String fromAction, java.lang.String outcome)
          Get a control flow case.
 ControlFlowCase getDefaultCase()
           
 ActivityId getFromActivityId()
          Get the from activity ID.
 java.util.Map<java.lang.String,ControlFlowCase> getOutcomeOnlyCases()
          'from-outcome' control flow cases are returned in the order defined.
 java.util.Collection<ActivityId> getTargetActivityIds()
          Get a collection of activities this rule may target.
 boolean removeControlFlowCase(ControlFlowCase cfCase)
          Removes a control flow case with matching from-outcome, from-action and a to-activity-id from this control flow rule.
 boolean setFromActivityId(java.lang.String fromActivityId)
          Changes the from-activity id for this control flow rule.

 

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

getFromActivityId

ActivityId getFromActivityId()
Get the from activity ID. The from activity is the activity this control flow rule flows away from.
Returns:
from activity ID.

getControlFlowCase

ControlFlowCase getControlFlowCase(java.lang.String fromAction,
                                   java.lang.String outcome)
Get a control flow case.
Parameters:
fromAction - the action, if any, performed by the from activity.
outcome - the logical outcome.
Returns:
the matching ControlFlowCase or null if one was not found.

getTargetActivityIds

java.util.Collection<ActivityId> getTargetActivityIds()
Get a collection of activities this rule may target.
Returns:
collection of activity IDs.

getActionAndOutcomeCases

java.util.Map<java.lang.String,ControlFlowCase> getActionAndOutcomeCases()
Returns:
a Map of ContolFlowCases with both 'from-action' and 'from-outcome' specified.

getActionOnlyCases

java.util.Map<java.lang.String,ControlFlowCase> getActionOnlyCases()
Returns:
a Map of ContolFlowCases with only 'from-action' specified.

getOutcomeOnlyCases

java.util.Map<java.lang.String,ControlFlowCase> getOutcomeOnlyCases()
'from-outcome' control flow cases are returned in the order defined.
Returns:
a Map of ContolFlowCases with only 'from-outcome' specified, keyed by 'from-outcome'.

getDefaultCase

ControlFlowCase getDefaultCase()
Returns:
a default ContolFlowCase, if specified.

setFromActivityId

boolean setFromActivityId(java.lang.String fromActivityId)
Changes the from-activity id for this control flow rule.
Parameters:
fromActivityId - new activity id
Returns:
true, if from-activity-id was successfully set, false otherwise

addControlFlowCase

boolean addControlFlowCase(ControlFlowCase cfCase)
Adds a new control flow case to this control flow rule.
Parameters:
cfCase - a new control flow case.
Returns:
true, if control flow case was successfully added, false otherwise

removeControlFlowCase

boolean removeControlFlowCase(ControlFlowCase cfCase)
Removes a control flow case with matching from-outcome, from-action and a to-activity-id from this control flow rule.
Parameters:
cfCase - a control flow case to remove
Returns:
true, if control flow case was successfully removed, false otherwise

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Controller
11g Release 2 (11.1.2.3.0)

E17480-04


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