Package com.arjuna.mw.wscf.model.sagas.participants

Interface Participant

All Known Subinterfaces:

ParticipantWithComplete

public interface Participant

This is the interface that all two-phase aware participants must define.

Since:

1.0.

Version:

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

Author:

Mark Little (mark.little@arjuna.com)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel the participant at top-level.
void	close()	Confirm the participant at top-level.
void	compensate()	Compensate the participant.
void	forget()	Inform the participant that is can forget the heuristic result.
String	id()
boolean	restore_state(InputObjectState os)
boolean	save_state(OutputObjectState os)

Method Details

close

void close()
    throws InvalidParticipantException,
WrongStateException,
SystemException

Confirm the participant at top-level.

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid (e.g., refers to an unknown participant.)

WrongStateException - Thrown if the state of the participant is such that it cannot confirm.

SystemException - Thrown if some other error occurred.

cancel

void cancel()
     throws InvalidParticipantException,
WrongStateException,
SystemException

Cancel the participant at top-level.

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid (e.g., refers to an unknown participant.)

WrongStateException - Thrown if the state of the participant is such that it cannot cancel.

SystemException - Thrown if some other error occurred.

compensate

void compensate()
         throws CompensateFailedException,
InvalidParticipantException,
WrongStateException,
SystemException

Compensate the participant.

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid (e.g., refers to an unknown participant.)

WrongStateException - Thrown if the state of the participant is such that it cannot cancel.

SystemException - Thrown if some other error occurred.

CompensateFailedException

forget

void forget()
     throws InvalidParticipantException,
WrongStateException,
SystemException

Inform the participant that is can forget the heuristic result.

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid.

WrongStateException - Thrown if the participant is in an invalid state.

SystemException - Thrown in the event of a general fault.

id

String id()
   throws SystemException

Throws:

SystemException

save_state

boolean save_state(OutputObjectState os)

restore_state

boolean restore_state(InputObjectState os)