Package com.arjuna.mw.wsas.activity

Interface Outcome

All Known Implementing Classes:
CoordinationOutcome, CoordinationOutcome
public interface 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.
Since:
1.0.
Version:
$Id: Outcome.java,v 1.2 2005/05/19 12:13:16 nmcl Exp $
Author:
Mark Little (mark.little@arjuna.com)

  • Method Summary

    Modifier and Type
    Method
    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.

  • Method Details

    • name

      String name() throws SystemException
      Give a name for this 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

      CompletionStatus completedStatus() throws SystemException
      The state in which the activity completed.
      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

      Object data() throws SystemException
      Outcome specific information that can be used to determine finer level details about the outcome instance.
      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.