oracle.adf.controller.metadata.model
Interface PageFlow

All Superinterfaces:

AdfcNode, IdHolder, NodeHolder, UIInfo

All Known Subinterfaces:

MetadataResource, TaskFlowDefinition

public interface PageFlow
extends UIInfo

An instance of a page flow. A page flow may be within a task flow or it may be the top-level ADF page flow. The top level page flow is the union of all activities and control flow rules that do not reside within a task flow. Page flow also contains managed bean definitions for beans used by activities in the page flow.

Method Summary

boolean	addActivity(java.lang.String activityId, java.lang.String type, Activity metadata) Adds an activity definition to this page flow.
boolean	addControlFlowRule(ControlFlowRule rule) Adds a new control flow rule to this page flow.
boolean	addManagedBean(ManagedBean bean) Adds a new managed bean definition to the task flow.
java.util.Map<ActivityId,Activity>	getActivities() Returns a Map of page flow activities keyed by activity ID.
ControlFlowRule	getControlFlowRule(java.lang.String fromActivityId) Returns a control flow rule corresonding to the from activity in this page flow.
java.util.Map<ActivityId,ControlFlowRule>	getControlFlowRules() Get the control flow rules for the flow.
ActivityId	getExceptionHandlerId() Get the activity ID of a exception handler activity, if one is specified in this PageFlow.
java.util.Map<java.lang.String,ManagedBean>	getManagedBeans() Get the managed bean definitions for the flow.
Security	getSecurity() Returns the security settings for this task flow.
boolean	removeActivity(java.lang.String activityId, Activity metadata) Removes an activity definition matching activity id from this resource.
boolean	removeControlFlowRule(ControlFlowRule rule) Removes control flow rule from this page flow.
boolean	removeManagedBean(ManagedBean bean) Removes specified managed bean from the task flow.

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

getControlFlowRules

java.util.Map<ActivityId,ControlFlowRule> getControlFlowRules()

Get the control flow rules for the flow. The Map of control flow rules is keyed by the fully qualified ID of the rule's from activity.

Returns:

an unmodifiable map of control flow rules.

getActivities

java.util.Map<ActivityId,Activity> getActivities()

Returns a Map of page flow activities keyed by activity ID.

Returns:

map of all the page flow's activities.

getManagedBeans

java.util.Map<java.lang.String,ManagedBean> getManagedBeans()

Get the managed bean definitions for the flow. The Map of managed beans is keyed by managed bean name.

Returns:

an unmodifiable map of managed bean definitions.

getExceptionHandlerId

ActivityId getExceptionHandlerId()

Get the activity ID of a exception handler activity, if one is specified in this PageFlow.

Returns:

activity id for the exception handler or null

getSecurity

Security getSecurity()

Returns the security settings for this task flow.

Returns:

The security object

See Also:

Security

addActivity

boolean addActivity(java.lang.String activityId,
                    java.lang.String type,
                    Activity metadata)

Adds an activity definition to this page flow.

Parameters:

activityId - activity id for a new activity, for example, "view1"

type - activity type, for example, ActivityType.VIEW

metadata - the metadata for this activity. Activities can be created by: AdfcElementFactory.

Returns:

true, if activity was successfully added, false otherwise

See Also:

ActivityType

removeActivity

boolean removeActivity(java.lang.String activityId,
                       Activity metadata)

Removes an activity definition matching activity id from this resource.

Parameters:

activityId - activity id, for example, "view1".

metadata - the metadata for the activity to remove.

Returns:

true, if activity was successfully removed, false otherwise

getControlFlowRule

ControlFlowRule getControlFlowRule(java.lang.String fromActivityId)

Returns a control flow rule corresonding to the from activity in this page flow.

Parameters:

fromActivityId - the matching "from-activity-id". For the wildcard control flow rule, use "*".

Returns:

a control flow rule or null, if no matching rule could be found

addControlFlowRule

boolean addControlFlowRule(ControlFlowRule rule)

Adds a new control flow rule to this page flow. The new control flow rule can be created by calling AdfcElementFactory.createControlFlowRule(java.util.List).

If the metadata resource was obtained with integral validation skipped, the rule will be added to the pageflow regardless of whether the source activity exists in the page flow.

Parameters:

rule - the metadata representation of the control flow rule

Returns:

true, if control flow rule was successfully added, false otherwise

removeControlFlowRule

boolean removeControlFlowRule(ControlFlowRule rule)

Removes control flow rule from this page flow.

Parameters:

rule - mutable control flow rule to remove

Returns:

true, if control flow rule was successfully added, false otherwise

addManagedBean

boolean addManagedBean(ManagedBean bean)

Adds a new managed bean definition to the task flow. The bean cannot be null and its name cannot match a name of already existing managed bean.

Parameters:

bean - the new bean to be added

Returns:

true, if bean was successfully added, false otherwise

removeManagedBean

boolean removeManagedBean(ManagedBean bean)

Removes specified managed bean from the task flow. The bean cannot be null and it has to exist in the task flow.

Parameters:

bean - the bean to be removed

Returns:

true, if bean was successfully removed, false otherwise