Skip navigation links

com.oracle.bpel.client
Interface IInstanceMetaData

All Superinterfaces:

IInstanceConstants

public interface IInstanceMetaData

extends IInstanceConstants

The IInstanceMetaData interface represents an instance in the process domain. The IActivityMetaData interface represents an activity in process domain. Conceptually, an activity represents a unit of work to be performed by a performer; the performer can either be manual (in which case it is called a task) or automated (either local or remote, as in the case of a web service invocation). This interface allows the user to introspect an activity's attributes.

Since:

1.0

Field Summary

Fields inherited from interface com.oracle.bpel.client.IInstanceConstants

PRIORITY_NORMAL, STATE_CLOSED_ABORTED, STATE_CLOSED_CANCELLED, STATE_CLOSED_COMPLETED, STATE_CLOSED_FAULTED, STATE_CLOSED_PENDING_CANCEL, STATE_CLOSED_STALE, STATE_INITIATED, STATE_OPEN_FAULTED, STATE_OPEN_RUNNING, STATE_OPEN_SUSPENDED

Method Summary

java.lang.String	getConversationId() Returns the conversationId of this instance.
java.util.Date	getCreationDate() Returns the creation date of this instance.
java.lang.String	getCreator() Returns the creator date of this instance.
java.lang.String	getDomainId() Returns the identifier of the process domain that this instance belongs to.
long	getId() Returns the instance id of the instance.
java.lang.String	getMetadata() Returns the user specified metadata of this instance.
java.util.Date	getModifyDate() Returns the date this instance was last modified on.
java.lang.String	getParentId() Returns the parentId of this instance.
int	getPriority() Retrieves the current priority of this instance.
java.lang.String	getProcessGUID() Returns the unique identifier for the process that this instance belongs to.
java.lang.String	getProcessId() Returns the identifier of the process that this instance belongs to.
java.lang.String	getRevisionTag() Returns the revision tag of the process that this instance belongs to.
java.lang.String	getRootId() Returns the rootId of this instance.
java.lang.String	getStage() Retrieves the current stage of this instance.
int	getState() Returns the current state of this instance.
java.lang.String	getStatus() Retrieves the current status of this instance.
java.lang.String	getTitle() Retrieves the current title of this instance.
boolean	isCancelled() Returns true if this instance has been cancelled.
boolean	isClosed() Returns true if the state of this instance is either one of: closed.pending.cancel closed.completed closed.faulted closed.cancelled closed.aborted closed.stale
boolean	isComplete() Returns true if this instance is completed.
boolean	isFaulted() Returns true if this instance has completed abnormally (that is, due to a fault/exception).
boolean	isOpen() Returns true if the state of this instance is either one of: open.running open.suspended open.faulted
boolean	isStale() Returns true if this instance has been marked as stale.
boolean	isTestCase() Returns true if this instance is a test case.

Method Detail

getId

long getId()

Returns the instance id of the instance. The instance id is a process domain key that uniquely identifies the instance in the domain.

getDomainId

java.lang.String getDomainId()

Returns the identifier of the process domain that this instance belongs to.

getProcessId

java.lang.String getProcessId()

Returns the identifier of the process that this instance belongs to.

getRevisionTag

java.lang.String getRevisionTag()

Returns the revision tag of the process that this instance belongs to. Each process deployed to the process domain contains a revision tag to distiguish between different versions of the same process.

getProcessGUID

java.lang.String getProcessGUID()

Returns the unique identifier for the process that this instance belongs to. When each process archive is generated by the bpelc tool, a unique identifier is generated to identify the process from other processes generated with the same identifier and revision tag.

getCreationDate

java.util.Date getCreationDate()

Returns the creation date of this instance.

getCreator

java.lang.String getCreator()

Returns the creator date of this instance.

getModifyDate

java.util.Date getModifyDate()

Returns the date this instance was last modified on.

getState

int getState()

Returns the current state of this instance.

isOpen

boolean isOpen()

Returns true if the state of this instance is either one of:

• open.running
• open.suspended
• open.faulted

See Also:

IInstanceConstants

isClosed

boolean isClosed()

Returns true if the state of this instance is either one of:

• closed.pending.cancel
• closed.completed
• closed.faulted
• closed.cancelled
• closed.aborted
• closed.stale

See Also:

IInstanceConstants

isComplete

boolean isComplete()

Returns true if this instance is completed. An instance is complete if it does not contain any active activities.

isCancelled

boolean isCancelled()

Returns true if this instance has been cancelled. Instances that terminate due to a fault condition while executing are considered faulted. Instances that are cancelled have had administrative action taken upon them.

See Also:

IInstanceConstants

isFaulted

boolean isFaulted()

Returns true if this instance has completed abnormally (that is, due to a fault/exception).

See Also:

IInstanceConstants

isStale

boolean isStale()

Returns true if this instance has been marked as stale. When a BPEL process is deployed on top of an existing (that is, deployed) BPEL process with the same process identifier and revision tag, all instances created from the old BPEL process are marked as stale and cannot be acted upon any longer.

Instances belonging to undeployed processes are also marked as stale.

See Also:

IInstanceConstants

getPriority

int getPriority()

Retrieves the current priority of this instance. The priority for the instance can be set via the setPriority() method from a BPELX java exec tag.

The semantics attached to the priority value are the sole domain and responsibility of the developer.

getTitle

java.lang.String getTitle()

Retrieves the current title of this instance. The title for the instance can be set via the setTitle() method from a BPELX java exec tag.

getStatus

java.lang.String getStatus()

Retrieves the current status of this instance. The status for the instance can be set via the setStatus() method from a BPELX java exec tag.

The semantics attached to the status value are the sole domain and responsibility of the developer.

getStage

java.lang.String getStage()

Retrieves the current stage of this instance. The stage for the instance can be set via the setStage() method from a BPELX java exec tag.

The semantics attached to the stage value are the sole domain and responsibility of the developer.

getConversationId

java.lang.String getConversationId()

Returns the conversationId of this instance. When an instance is created the user may pass the process domain a user-specified key; this key has no system-specific meaning and is only available as a means for linking a Collaxa process instance with an external system.

The semantics attached to the status value are the sole domain and responsibility of the user.

getRootId

java.lang.String getRootId()

Returns the rootId of this instance. When an instance is created the user may pass the process domain a user-specified key. This key will then be passed as part of the requests to other processes being called. This key has no system-specific meaning and is only available as a means for identifying a set of related instances.

The semantics attached to the status value are the sole domain and responsibility of the user.

getParentId

java.lang.String getParentId()

Returns the parentId of this instance. When an instance is calling other instance, a system specified id is passed. This id is identified by the instance being called as the parentId. This id can be used to locate the caller of an instance.

The semantics attached to the status value are the sole domain and responsibility of the user.

getMetadata

java.lang.String getMetadata()

Returns the user specified metadata of this instance. When an instance is created the user may pass the process domain a user-specified metadata string.

The semantics attached to the value of the key are the sole domain and responsibility of the developer.

The metadata is similar to the custom key, only metadata is larger.

isTestCase

boolean isTestCase()

Returns true if this instance is a test case.

Skip navigation links