com.arjuna.wst
Interface BusinessAgreementWithParticipantCompletionParticipant

All Known Subinterfaces:
BusinessAgreementWithCoordinatorCompletionParticipant

public interface BusinessAgreementWithParticipantCompletionParticipant


Method Summary
 void cancel()
          The transaction has cancelled, and the participant should undo any work.
 void close()
          The transaction has completed successfully.
 void compensate()
          The transaction has cancelled.
 void error()
          If the participant enquired as to the status of the transaction it was registered with and an error occurs (e.g., the transaction service is unavailable) then this operation will be invoked.
 java.lang.String status()
           
 void unknown()
          If the participant enquires as to the status of the transaction it was registered with and that transaction is no longer available (has rolled back) then this operation will be invoked by the coordination service.
 

Method Detail

close

void close()
           throws WrongStateException,
                  SystemException
The transaction has completed successfully. The participant previously informed the coordinator that it was ready to complete.

Throws:
WrongStateException
SystemException

cancel

void cancel()
            throws WrongStateException,
                   SystemException
The transaction has cancelled, and the participant should undo any work. The participant cannot have informed the coordinator that it has completed.

Throws:
WrongStateException
SystemException

compensate

void compensate()
                throws FaultedException,
                       WrongStateException,
                       SystemException
The transaction has cancelled. The participant previously informed the coordinator that it had finished work but could compensate later if required, so it is now requested to do so.

Throws:
FaultedException - if the participant was unable to perform the required compensation action because of an unrecoverable error. The coordinator is notified of this fault and as a result will stop resending compensation requests.
SystemException - if the participant was unable to perform the required compensation action because of a transient fault. The coordinator is not notified of this fault so it will retry the compensate request after a suitable timeout.
WrongStateException

status

java.lang.String status()
                        throws SystemException
Returns:
the status value.
Throws:
SystemException

unknown

void unknown()
             throws SystemException
If the participant enquires as to the status of the transaction it was registered with and that transaction is no longer available (has rolled back) then this operation will be invoked by the coordination service.

Throws:
SystemException

error

void error()
           throws SystemException
If the participant enquired as to the status of the transaction it was registered with and an error occurs (e.g., the transaction service is unavailable) then this operation will be invoked.

Throws:
SystemException