com.ibm.ws.javax.activity
Class ActivityInformation

java.lang.Object
  |
  +--com.ibm.ws.javax.activity.ActivityInformation
All Implemented Interfaces:
java.io.Serializable
public class ActivityInformation
extends java.lang.Object
implements java.io.Serializable

The ActivityInformation class is provided by the Activity service to assist an Action that has registered interest with a system SignalSet to extract the information from Signals produced by that SignalSet. Such Signals contain an org.omg.CosActivity.ActivityInformation structure encoded in an org.omg.CORBA.Any. The org.omg.CosActivity.ActivityInformation structure is defined in the OMG Activity service specification and consists of a GlobalId, CompletionStatus and Outcome.
javax.activity.ActivityInformation extends java.io.Serializable and so an instance of this interface may be obtained from a system Signal (such as preCompletion) via its getExtendedValue method.

See Also:
Serialized Form

Constructor Summary
ActivityInformation(GlobalId globalId, int completionStatus)
          Constructs an ActivityInformation object, describing the Activity, from the GlobalId and CompletionStatus.
ActivityInformation(GlobalId globalId, int completionStatus, Outcome finalOutcome)
          Constructs an ActivityInformation object, describing the Activity, from the GlobalId, CompletionStatus and final Outcome.
 
Method Summary
 int getCompletionStatus()
          Returns the CompletionStatus contained within the ActivityInformation.
 Outcome getFinalOutcome()
          Returns the Outcome contained within the ActivityInformation.
 GlobalId getGlobalId()
          Returns the GlobalId contained within the ActivityInformation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActivityInformation

public ActivityInformation(GlobalId globalId,
                           int completionStatus)
Constructs an ActivityInformation object, describing the Activity, from the GlobalId and CompletionStatus. The final Outcome of an ActivityInformation object so contructed is nil. An object of this type is encoded in the extendedData of Signals sent by the predefined system SignalSets.

ActivityInformation

public ActivityInformation(GlobalId globalId,
                           int completionStatus,
                           Outcome finalOutcome)
Constructs an ActivityInformation object, describing the Activity, from the GlobalId, CompletionStatus and final Outcome. An object of this type is encoded in the extendedData of the postComplete signal sent by the system SynchronizationSignalSet.

Method Detail

getGlobalId

public GlobalId getGlobalId()
Returns the GlobalId contained within the ActivityInformation.

Returns:
The GlobalId of the Activity within which context the Signal was sent.

getCompletionStatus

public int getCompletionStatus()
Returns the CompletionStatus contained within the ActivityInformation.

Returns:
The CompletionStatus of the Activity within which context the Signal was sent.

getFinalOutcome

public Outcome getFinalOutcome()
Returns the Outcome contained within the ActivityInformation.

Returns:
The Outcome of the Activity within which context the Signal was sent.

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.