com.arjuna.mwlabs.wst11.ba.participants

Class BusinessAgreementWithParticipantCompletionImple

java.lang.Object

com.arjuna.mwlabs.wst11.ba.participants.BusinessAgreementWithParticipantCompletionImple

All Implemented Interfaces:

Participant

Direct Known Subclasses:

BusinessAgreementWithCoordinatorCompletionImple

public class BusinessAgreementWithParticipantCompletionImple
extends Object
implements Participant

Since:

1.0.

Version:

$Id: BusinessAgreementWithParticipantCompletionImple.java,v 1.1.2.2 2004/08/09 12:34:26 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected BusinessAgreementWithParticipantCompletionParticipant	_resource

Constructor Summary

Constructors

Constructor and Description
BusinessAgreementWithParticipantCompletionImple() this constructor is used during recovery and does not install a participant manager.
BusinessAgreementWithParticipantCompletionImple(BAParticipantManager participantManager, BusinessAgreementWithParticipantCompletionParticipant resource, String id) this constructor installs the supplied participant manager
BusinessAgreementWithParticipantCompletionImple(BusinessAgreementWithParticipantCompletionParticipant resource, String id) this constructor installs a participant manager which routes messages via the current activity

Method Summary

Modifier and Type	Method and 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()
BAParticipantManager	participantManager()
boolean	restore_state(com.arjuna.ats.arjuna.state.InputObjectState is)
boolean	save_state(com.arjuna.ats.arjuna.state.OutputObjectState os)
String	status()
void	unknown()

Methods inherited from class java.lang.Object

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

Field Detail

_resource

protected BusinessAgreementWithParticipantCompletionParticipant _resource

Constructor Detail

BusinessAgreementWithParticipantCompletionImple

public BusinessAgreementWithParticipantCompletionImple(BusinessAgreementWithParticipantCompletionParticipant resource,
                                                       String id)

this constructor installs a participant manager which routes messages via the current activity

Parameters:

resource -

id -

BusinessAgreementWithParticipantCompletionImple

public BusinessAgreementWithParticipantCompletionImple(BAParticipantManager participantManager,
                                                       BusinessAgreementWithParticipantCompletionParticipant resource,
                                                       String id)

this constructor installs the supplied participant manager

Parameters:

participantManager -

resource -

id -

BusinessAgreementWithParticipantCompletionImple

public BusinessAgreementWithParticipantCompletionImple()

this constructor is used during recovery and does not install a participant manager. the resource and identifier will be initialised by loading saved state

Method Detail

close

public void close()
           throws InvalidParticipantException,
                  WrongStateException,
                  SystemException

Description copied from interface: Participant

Confirm the participant at top-level.

Specified by:

close in interface 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 confirm.

SystemException - Thrown if some other error occurred.

cancel

public void cancel()
            throws CancelFailedException,
                   InvalidParticipantException,
                   WrongStateException,
                   SystemException

Description copied from interface: Participant

Cancel the participant at top-level.

Specified by:

cancel in interface 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.

CancelFailedException

compensate

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

Description copied from interface: Participant

Compensate the participant.

Specified by:

compensate in interface 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

status

public String status()
              throws SystemException

Returns:

the status value.

Throws:

SystemException

forget

public void forget()
            throws InvalidParticipantException,
                   WrongStateException,
                   SystemException

Inform the participant that is can forget the heuristic result.

Specified by:

forget in interface Participant

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.

unknown

public void unknown()
             throws SystemException

Throws:

SystemException

id

public String id()
          throws SystemException

Specified by:

id in interface Participant

Throws:

SystemException

participantManager

public final BAParticipantManager participantManager()

save_state

public boolean save_state(com.arjuna.ats.arjuna.state.OutputObjectState os)

Specified by:

save_state in interface Participant

restore_state

public boolean restore_state(com.arjuna.ats.arjuna.state.InputObjectState is)

Specified by:

restore_state in interface Participant