oracle.adf.controller
Class TaskFlowId

java.lang.Object
  oracle.adf.controller.TaskFlowId

All Implemented Interfaces:

java.io.Serializable

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

Uniquely identifies a task flow definition.

See Also:

Serialized Form

Constructor Summary

TaskFlowId(java.lang.String identifier)
Deprecated. use the parse(String) method instead.

TaskFlowId(java.lang.String documentName, java.lang.String localTaskFlowId)
Constructor.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getDocumentName()
java.lang.String	getFullyQualifiedName() Gets the fully qualified name for this taskflow id. This is of the form <document name>#<local task flow id> For example, "/WEB-INF/mytask.xml#mytask" "/WEB-INF/po/enter-order.xml#enter-order In the event of change, this fully qualified name is guranteed to be backward compatible.
java.lang.String	getLocalTaskFlowId()
int	hashCode()
static TaskFlowId	parse(java.lang.String identifier) Construct a task flow ID from the string representation of the task flow ID.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskFlowId

public TaskFlowId(java.lang.String documentName,
                  java.lang.String localTaskFlowId)

Constructor.

Parameters:

documentName - the name of the XML document that contains this task flow definition.

localTaskFlowId - the name of the task flow inside the XML document.

TaskFlowId

@Deprecated
public TaskFlowId(java.lang.String identifier)

Deprecated. use the parse(String) method instead.

Constructor. Expects the format to be: <document>#<id>
For example: /WEB-INF/mytask.xml#taskA
specifies that the document is /WEB-INF/mytask.xml and the task flow id is taskA.

Parameters:

identifier - the unique taskflow identifier

Method Detail

getDocumentName

public java.lang.String getDocumentName()

Returns:

the name of the document that contains this task flow.

getLocalTaskFlowId

public java.lang.String getLocalTaskFlowId()

Returns:

task flow name inside the document.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

true, if both document name and local task flow ID are equal

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:

readeable task flow ID: document name followed by '#' and local task flow id.

getFullyQualifiedName

public java.lang.String getFullyQualifiedName()

Gets the fully qualified name for this taskflow id.
This is of the form
<document name>#<local task flow id>
For example,
"/WEB-INF/mytask.xml#mytask"
"/WEB-INF/po/enter-order.xml#enter-order
In the event of change, this fully qualified name is guranteed to be backward compatible.

Returns:

the fully qualified String representation of this TaskFlowId

parse

public static TaskFlowId parse(java.lang.String identifier)

Construct a task flow ID from the string representation of the task flow ID.

Expects the format to be: <document>#<id>
For example: /WEB-INF/mytask.xml#taskA
specifies that the document is /WEB-INF/mytask.xml and the task flow id is taskA.

Parameters:

identifier - string representation of a task flow ID.

Returns:

TaskFlowId constructed from the provided identifier string.