com.ibm.ws.javax.activity
Class Outcome

java.lang.Object
  |
  +--com.ibm.ws.javax.activity.Outcome
public class Outcome
extends java.lang.Object

An Outcome is produced by, and given meaning by, a SignalSet when it has finished producing signals. A CompletionSignalSet produces such an Outcome and this is returned on the complete() and completeWithStatus(CompletionStatus) methods of the UserActivity interface.

Constructor Summary
Outcome(java.lang.String outcomeName, org.omg.CORBA.Any extOutcome)
          Constructor used by the Activity service or HLS to create an Outcome object.
Outcome(java.lang.String outcomeName, java.rmi.MarshalledObject extOutcome)
          Constructor used by the Activity service to create an Outcome object.
Outcome(java.lang.String outcomeName, java.io.Serializable extOutcome)
          Constructor used by a HLS to create an Outcome object.
 
Method Summary
 org.omg.CORBA.Any getExtendedAny()
          Returns a CORBA Any that contains information specific to the Outcome.
 java.io.Serializable getExtendedValue()
          Returns a java.io.Serializable that contains information specific to the Outcome.
 java.lang.String getName()
          Returns a String that identifies the Outcome name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Outcome

public Outcome(java.lang.String outcomeName,
               java.io.Serializable extOutcome)
Constructor used by a HLS to create an Outcome object. The Activity service encapsulates the Serializable extOutcome in a java.rmi.MarshalledObject to avoid class-loading problems when propagating CosActivity.Outcome structures containing this object.

Parameters:
outcomeName - The name of the Outcome.
extOutcome - Data that is specific to a particular Outcome.

Outcome

public Outcome(java.lang.String outcomeName,
               java.rmi.MarshalledObject extOutcome)
Constructor used by the Activity service to create an Outcome object. It is used by the Activity service when processing a received CosActivity.Outcome if the CosActivity.Outcome.application_specific_data field of that Outcome contains a MarshalledObject.

Parameters:
outcomeName - The name of the Outcome.
extOutcome - Data that is specific to a particular Outcome.

Outcome

public Outcome(java.lang.String outcomeName,
               org.omg.CORBA.Any extOutcome)
Constructor used by the Activity service or HLS to create an Outcome object.
It is used by the Activity service when processing a received CosActivity.Outcome if the CosActivity.Outcome.application_specific_data field of that Outcome does not contain a MarshalledObject.
It may also used by a HLS to create an Outcome.

Parameters:
outcomeName - The name of the Outcome.
Method Detail

getName

public java.lang.String getName()
Returns a String that identifies the Outcome name.

Returns:
The Outcome name.

getExtendedValue

public java.io.Serializable getExtendedValue()
Returns a java.io.Serializable that contains information specific to the Outcome. If this extended data is not a Serializable object then this method returns null and getExtendedAny should be called instead.

Returns:
A java.io.Serializable that contains information specific to the Outcome. Returns null if the extended data is not a Serializable object.

getExtendedAny

public org.omg.CORBA.Any getExtendedAny()
Returns a CORBA Any that contains information specific to the Outcome.

Returns:
A CORBA Any that contains information specific to the Outcome.

 

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.