oracle.adf.controller.metadata
Class ActivityId

java.lang.Object
  oracle.adf.controller.metadata.ActivityId

All Implemented Interfaces:

java.io.Serializable

public class ActivityId
extends java.lang.Object
implements java.io.Serializable

Uniquely identifies an activity instance.

See Also:

Serialized Form

Field Summary

static char	DOCUMENT_DELIMITER Delimiter following the metadata document name.
static char	TASK_FLOW_DELIMITER Delimiter between the taskFlowId and the activityId.
static java.lang.String	WILDCARD_ID

Constructor Summary

ActivityId(java.lang.String localActivityId)
Convenience constructor for activities in the unbounded task flow.

ActivityId(TaskFlowId taskFlowId, java.lang.String localActivityId)
Constructor.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getLocalActivityId() Get the local activity ID.
TaskFlowId	getTaskFlowId() Get the task flow ID of the task flow containing the activity.
java.lang.String	getViewId()
int	hashCode()
static ActivityId	parse(java.lang.String string) Parse a string into an activity ID.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DOCUMENT_DELIMITER

public static final char DOCUMENT_DELIMITER

Delimiter following the metadata document name.

See Also:

Constant Field Values

WILDCARD_ID

public static final java.lang.String WILDCARD_ID

See Also:

Constant Field Values

TASK_FLOW_DELIMITER

public static final char TASK_FLOW_DELIMITER

Delimiter between the taskFlowId and the activityId.

See Also:

Constant Field Values

Constructor Detail

ActivityId

public ActivityId(TaskFlowId taskFlowId,
                  java.lang.String localActivityId)

Constructor.

Parameters:

taskFlowId - the task flow ID of the task flow containing the activity or null if the activity resides in the ADF page flow.

localActivityId - the local activity ID (i.e. the ID within the task flow).

ActivityId

public ActivityId(java.lang.String localActivityId)

Convenience constructor for activities in the unbounded task flow. Using this constructor is the same as new ActivityId(null, localActivityId).

This constructor is useful for constructing ActivityIds for plain pages in the unbounded task flow. For example, you can create an ActivityId for a plain page with a viewId of "/foo.jspx" with new ActivityId("/foo.jspx").

Parameters:

localActivityId - the local activity ID (i.e. the ID within the task flow).

Method Detail

getTaskFlowId

public TaskFlowId getTaskFlowId()

Get the task flow ID of the task flow containing the activity.

Returns:

the task flow ID or null if the activity resides in the ADF page flow.

getLocalActivityId

public java.lang.String getLocalActivityId()

Get the local activity ID.

Returns:

the local activity ID.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

getViewId

public java.lang.String getViewId()

Returns:

The JSF viewId representation for this activity.

parse

public static ActivityId parse(java.lang.String string)

Parse a string into an activity ID.

There are two formats that may be used:

• file name#task-flow-id@activity-id
• activity-id

The first format is for activities within a task flow while the second format is for activities in the top-level ADF page flow.

Parameters:

string - the string to parse.

Returns:

the resulting activity ID.