com.arjuna.mw.wscf.model.sagas.outcomes

Class CoordinationOutcome

java.lang.Object

com.arjuna.mw.wscf.model.sagas.outcomes.CoordinationOutcome

All Implemented Interfaces:

Outcome

public class CoordinationOutcome
extends Object
implements Outcome

The CoordinationOutcome represents the final outcome of the coordination event. The CompletionStatus and the actual two-phase status value are returned.

Version:

$Id: CoordinationOutcome.java,v 1.3 2005/05/19 12:13:24 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Constructor Summary

Constructors

Constructor and Description
CoordinationOutcome(CompletionStatus s, int sagas)
CoordinationOutcome(int sagas)

Method Summary

Methods

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.
String	name() Give a name for this outcome.
int	result()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordinationOutcome

public CoordinationOutcome(int sagas)

CoordinationOutcome

public CoordinationOutcome(CompletionStatus s,
                   int sagas)

Method Detail

result

public final int result()

Returns:

the two-phase status result.

See Also:

TwoPhaseResult

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.

toString

public String toString()

Overrides:

toString in class Object