com.oracle.bpel.client
Interface IActivityMetaData

All Superinterfaces:

IActivityConstants

public interface IActivityMetaData

extends IActivityConstants

The IActivityMetaData interface represents an activity in the 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.IActivityConstants

EXECUTION_TYPE_NORMAL, EXECUTION_TYPE_SCHEDULABLE, PERFORMER_ID_NOOP, PERFORMER_ID_SYSTEM, STATE_CLOSED_ABORTED, STATE_CLOSED_CANCELLED, STATE_CLOSED_COMPENSATED, STATE_CLOSED_COMPLETED, STATE_CLOSED_FAULTED, STATE_CLOSED_FINALIZED, STATE_CLOSED_PENDING_CANCEL, STATE_CLOSED_STALE, STATE_INACTIVE, STATE_OPEN_ACTIVE, STATE_OPEN_FAULTED, STATE_OPEN_PENDING_COMPLETE, STATE_OPEN_SUSPENDED

Method Summary

java.lang.String	getCorrelationId() Retrieves the correlation identifier of this activity in its "stringified" URI format.
java.util.Date	getCreationDate() Retrieves the creation date of this activity.
java.lang.String	getCustomId() Retrieves the custom identifier of this activity.
java.lang.String	getDomainId() Retrieves the identifier of the process domain that this activity belongs to.
java.util.Date	getExpirationDate() Retrieves the current expiration date set for this activity.
long	getInstanceId() Retrieves the instance id (key) of the instance that this activity belongs to.
java.lang.String	getLabel() Retrieves the label of this activity.
java.util.Date	getModifyDate() Retrieves the date this activity was last modified on.
int	getPriority() Retrieves the current priority of this activity.
java.lang.String	getProcessId() Retrieves the identifier of the process that this activity belongs to.
java.lang.String	getReferenceId() Retrieves the reference identifier of the instance that this activity is referring to.
java.lang.String	getRevisionTag() Retrieves the revision tag of the process that this activity belongs to.
int	getState() Retrieves the current state of this activity.
boolean	isCancelled() Returns true if this activity has been cancelled.
boolean	isClosed() Returns true if this activity is closed.
boolean	isComplete() Returns true if this activity is complete.
boolean	isExpired() Returns true if this activity has been expired.
boolean	isFaulted() Returns true if this activity has been faulted.
boolean	isOpen() Returns true if this activity is open.
boolean	isStale() Returns true if this activity has been marked as stale.

Method Detail

getInstanceId

public long getInstanceId()

Retrieves the instance id (key) of the instance that this activity belongs to.

getCorrelationId

public java.lang.String getCorrelationId()

Retrieves the correlation identifier of this activity in its "stringified" URI format. The correlation identifier is the key which can uniquely identify the activity within the process domain.

See Also:

CorrelationId

getReferenceId

public java.lang.String getReferenceId()

Retrieves the reference identifier of the instance that this activity is referring to. If an activity's performer is another instance (a "sub-instance") or another method (a "sub-method"), the identifier for that performer is stored as a reference identifier.

The reference identifier is returned in its "stringified" URI format. The reference identifier is the key which can uniquely identify the instance within the process domain.

See Also:

ReferenceId

getCreationDate

public java.util.Date getCreationDate()

Retrieves the creation date of this activity.

getModifyDate

public java.util.Date getModifyDate()

Retrieves the date this activity was last modified on.

getState

public int getState()

Retrieves the current state of this activity.

isOpen

public boolean isOpen()

Returns true if this activity is open. An activity is considered to be open if its state is one of:

• STATE_OPEN_ACTIVE
• STATE_OPEN_SUSPENDED
• STATE_OPEN_PENDING_COMPLETE

isClosed

public boolean isClosed()

Returns true if this activity is closed. An activity is considered to be closed if its state is one of:

• STATE_CLOSED_COMPLETED
• STATE_CLOSED_FINALIZED
• STATE_CLOSED_PENDING_CANCEL
• STATE_CLOSED_CANCELLED
• STATE_CLOSED_ABORTED
• STATE_CLOSED_COMPENSATED
• STATE_CLOSED_STALE

isComplete

public boolean isComplete()

Returns true if this activity is complete. An activity is considered to be complete if its state is:

• STATE_CLOSED_COMPLETED

isCancelled

public boolean isCancelled()

Returns true if this activity has been cancelled. An activity is considered to be cancelled if its state is one of:

• STATE_CLOSED_CANCELLED
• STATE_CLOSED_ABORTED

isFaulted

public boolean isFaulted()

Returns true if this activity has been faulted. If an activity is faulted it failed to handle a thrown fault. An activity is considered to be faulted if its state is one of:

• STATE_OPEN_FAULTED
• STATE_CLOSED_FAULTED
• STATE_CLOSED_PENDING_CANCEL

isStale

public boolean isStale()

Returns true if this activity has been marked as stale. If the process definition for the activity/instance is not the same as the one currently deployed on the BPEL server, all activities/instances belonging to the previous process definition revision are marked as stale.

getExpirationDate

public java.util.Date getExpirationDate()

Retrieves the current expiration date set for this activity. If the activity does not have an expiration date set, null is returned.

isExpired

public boolean isExpired()

Returns true if this activity has been expired. Note that even though an activity's expiration date may be later than the current time, the activity will not be marked as expired until the process domain expiration agent picks up the activity and actively expires it.

getPriority

public int getPriority()

Retrieves the current priority of this activity. Each activity can have its own priority; hence this value is different from the instance priority. The semantics attached to the priority value are the sole domain and responsibility of the user.

getLabel

public java.lang.String getLabel()

Retrieves the label of this activity.

getCustomId

public java.lang.String getCustomId()

Retrieves the custom identifier of this activity. When an activity is created the user may specify from the process code a custom identifier that should be associated with the activity; this key has no system- specific meaning and is only available as a means for linking a Collaxa activity with an external system.

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

getDomainId

public java.lang.String getDomainId()

Retrieves the identifier of the process domain that this activity belongs to.

getProcessId

public java.lang.String getProcessId()

Retrieves the identifier of the process that this activity belongs to.

getRevisionTag

public java.lang.String getRevisionTag()

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