oracle.adf.controller.metadata.model

Interface PageFlowBase

All Superinterfaces:

AdfcNode, IdHolder, NodeHolder, UIInfo

All Known Subinterfaces:

MetadataResource, MetadataResourceMobile, PageFlow, PageFlowMobile, TaskFlowDefinition, TaskFlowDefinitionMobile

public interface PageFlowBase
extends UIInfo

Method Summary

Modifier and Type	Method and Description
boolean	addActivity(java.lang.String activityId, java.lang.String type, Activity metadata) Adds an activity definition 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.
java.util.Map<java.lang.String,ManagedBean>	getManagedBeans() Get the managed bean definitions for the flow.
ActivityId	getViewActivity(java.lang.String viewId) Returns an ActivityId that corresponds to the supplied viewId.
boolean	removeActivity(java.lang.String activityId, Activity metadata) Removes an activity definition matching activity id from this resource.
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

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.

getViewActivity

ActivityId getViewActivity(java.lang.String viewId)

Returns an ActivityId that corresponds to the supplied viewId.

Parameters:

viewId - the JSF viewId

Returns:

the ActivityId for the View activity, or null if no corresponding View activity can be found.

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.

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

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