com.arjuna.mwlabs.wsas.activity

Class OutcomeImple

java.lang.Object

com.arjuna.mwlabs.wsas.activity.OutcomeImple

All Implemented Interfaces:

Outcome

public class OutcomeImple
extends Object
implements Outcome

The Outcome represents the final outcome of the activity. Because different HLS implementations will have different requirements on what they can or cannot return, this interface is deliberately generic.

Constructor Summary

Constructors

Constructor and Description
OutcomeImple(CompletionStatus s)
OutcomeImple(HLSException ex, CompletionStatus cs)

Method Summary

Modifier and Type	Method and Description
CompletionStatus	completedStatus() The state in which the activity completed.
Object	data() Outcome specific information that can be used to determine finer level details about the outcome instance.
HLSException	exception()
String	name() Give a name for this outcome.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutcomeImple

public OutcomeImple(CompletionStatus s)

OutcomeImple

public OutcomeImple(HLSException ex,
                    CompletionStatus cs)

Method Detail

name

public String name()
            throws SystemException

Give a name for this outcome.

Specified by:

name in interface Outcome

Returns:

some implementation specific name for the Outcome. Typically this will be the only thing necessary to determine the transaction's outcome, e.g., "RolledBack".

Throws:

SystemException - Thrown if an error occurs.

completedStatus

public CompletionStatus completedStatus()
                                 throws SystemException

The state in which the activity completed.

Specified by:

completedStatus in interface Outcome

Returns:

the final completion status of the transaction. Any additional information (e.g., exception types) may be provided by the data method.

Throws:

SystemException - Thrown if an error occurs.

data

public Object data()
            throws SystemException

Outcome specific information that can be used to determine finer level details about the outcome instance.

Specified by:

data in interface Outcome

Returns:

completion specific data for this activity. Examples include the type of failure exception that was thrown by the implementation (e.g., HeuristicMixed).

Throws:

SystemException - Thrown if an error occurs.

exception

public final HLSException exception()