Skip navigation links

com.oracle.bpel.client
Interface IActivityHandle

All Superinterfaces:

IActivityConstants

public interface IActivityHandle

extends IActivityConstants

The IActivityHandle interface allows the user to perform operations on an active activity. An activity in the process domain represents a unit of work to be performed by a performer/service; 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).

Activities, once started by the process domain, may be administered (for example, an activity may be suspended, resumed or aborted) or it may be operated on in a more user-like manner (for example, an event may be fired on the activity or an audit trail entry may be logged).

In addition to providing for operations to be performed on the activity, this interface also allows for attributes of the activity to be accessed; for instance, the expiration date or the current list of performers assigned to the activity.

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

void	abort() Aborts the activity.
void	abort(java.lang.String comments) Performs the same action as abort but allows the user to supply a comment that will be logged in the audit trail of the instance.
void	addAuditTrailEntry(java.lang.String message, java.lang.String detail) Adds an audit trail entry to the history of the instance that this activity belongs to.
void	expire() Expires the activity immediately.
void	expire(java.lang.String comments) Performs the same action as expire but allows the user to supply a comment that will be logged in the audit trail of the instance.
void	extend(java.util.Date expDate) Extends the expiration date of the activity to the specified date.
void	extend(java.util.Date expDate, java.lang.String comments) Performs the same action as extend( Date ) but allows the user to supply a comment that will be logged in the audit trail of the instance.
CorrelationId	getCorrelationId() Retrieves the correlation identifier of the activity.
java.util.Date	getCreationDate() Retrieves the creation date of this activity.
java.lang.String	getCustomId() Retrieves the custom identifier of this activity.
java.util.Date	getExpirationDate() Retrieves the current expiration date set for this activity.
IInstanceHandle	getInstance() Retrieves the handle to 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.
int	getState() Retrieves the current state of this activity.
boolean	isCancelled() Returns true if this activity has been cancelled.
boolean	isClosed() Returns true if the state of this activity is either one of: closed.completed closed.finalized closed.pending.cancel closed.cancelled closed.faulted closed.aborted closed.compensated closed.stale
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 completed abnormally (that is, due to a fault/exception).
boolean	isOpen() Returns true if the state of this activity is either one of: open.running open.suspended open.pending.complete open.faulted
boolean	isStale() Returns true if this activity has been marked as stale.

Method Detail

getCorrelationId

CorrelationId getCorrelationId()

Retrieves the correlation identifier of the activity. The correlation identifier is the key which can uniquely identify the activity within the process domain.

getInstance

IInstanceHandle getInstance()

Retrieves the handle to the instance that this activity belongs to. Each activity in the process domain is associated with an instance.

getCreationDate

java.util.Date getCreationDate()
                               throws ServerException

Retrieves the creation date of this activity.

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

getModifyDate

java.util.Date getModifyDate()
                             throws ServerException

Retrieves the date this activity was last modified on.

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

getExpirationDate

java.util.Date getExpirationDate()
                                 throws ServerException

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

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

getState

int getState()
             throws ServerException

Retrieves the current state of this activity.

Returns:

the current state of this activity as an int

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

See Also:

IActivityConstants

isOpen

boolean isOpen()
               throws ServerException

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

• open.running
• open.suspended
• open.pending.complete
• open.faulted

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

See Also:

IActivityConstants

isClosed

boolean isClosed()
                 throws ServerException

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

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

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

See Also:

IActivityConstants

isComplete

boolean isComplete()
                   throws ServerException

Returns true if this activity is complete.

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

See Also:

IActivityConstants

isExpired

boolean isExpired()
                  throws ServerException

Returns true if this activity has been expired.

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

isFaulted

boolean isFaulted()
                  throws ServerException

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

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

See Also:

IActivityConstants

isCancelled

boolean isCancelled()
                    throws ServerException

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

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

See Also:

IActivityConstants

isStale

boolean isStale()
                throws ServerException

Returns true if this activity 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 and activities 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.

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

See Also:

IActivityConstants

getPriority

int getPriority()
                throws ServerException

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.

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

getLabel

java.lang.String getLabel()
                          throws ServerException

Retrieves the label of this activity.

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

getCustomId

java.lang.String getCustomId()
                             throws ServerException

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 an Orabpel activity with an external system.

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

Throws:

ServerException - if there is a problem in fetching the meta data of this activity from the process domain.

addAuditTrailEntry

void addAuditTrailEntry(java.lang.String message,
                        java.lang.String detail)
                        throws ServerException

Adds an audit trail entry to the history of the instance that this activity belongs to.

Parameters:

title - the title of the audit trail entry.

summary - a brief summary of the audit trail entry.

comment - the detailed text of the entry.

Throws:

ServerException - if there is a problem in locating the activity in the process domain or if the requested action is not permitted (the activity this handle is referring to may have been changed in the meantime).

expire

void expire()
            throws ServerException

Expires the activity immediately. This method allows the user to expire an activity immediately instead of waiting for the system to do so.

Throws:

ServerException - if there is a problem in locating the activity in the process domain or if the requested action is not permitted (the activity this handle is referring to may have been changed in the meantime).

expire

void expire(java.lang.String comments)
            throws ServerException

Performs the same action as expire but allows the user to supply a comment that will be logged in the audit trail of the instance.

Parameters:

comments - the audit trail comment.

Throws:

ServerException - if there is a problem in locating the activity in the process domain or if the requested action is not permitted (the activity this handle is referring to may have been changed in the meantime).

extend

void extend(java.util.Date expDate)
            throws ServerException

Extends the expiration date of the activity to the specified date. The new expiration date is only applied to the activity if it is older than the current system time. If the activity already has an expiration date it will be replaced with the new date.

Parameters:

expDate - the new expiration date.

Throws:

ServerException - if there is a problem in locating the activity in the process domain or if the requested action is not permitted (the activity this handle is referring to may have been changed in the meantime).

extend

void extend(java.util.Date expDate,
            java.lang.String comments)
            throws ServerException

Performs the same action as extend( Date ) but allows the user to supply a comment that will be logged in the audit trail of the instance.

Parameters:

expDate - the new expiration date.

comments - the audit trail comment.

Throws:

ServerException - if there is a problem in locating the activity in the process domain or if the requested action is not permitted (the activity this handle is referring to may have been changed in the meantime).

abort

void abort()
           throws ServerException

Aborts the activity. Aborting an activity will not give the performer of the activity a chance to rollback or cancel work that has already been done. This method is provided for administrative purposes only and allows the administrator to remove a stalled activity from the system. Please note that aborting an activity is not the same as completing or force completing an activity; an abort is equivalent to a manual deletion of the activity from the database.

Throws:

ServerException - if there is a problem in locating the activity in the process domain or if the requested action is not permitted (the activity this handle is referring to may have been changed in the meantime).

abort

void abort(java.lang.String comments)
           throws ServerException

Performs the same action as abort but allows the user to supply a comment that will be logged in the audit trail of the instance.

Parameters:

comments - the audit trail comment.

Throws:

ServerException - if there is a problem in locating the activity in the process domain or if the requested action is not permitted (the activity this handle is referring to may have been changed in the meantime).

Skip navigation links