be.SIRAPRISE.messages
Class EndTransactionMessageType

java.lang.Object
  extended by be.SIRAPRISE.messages.ServerMessageType
      extended by be.SIRAPRISE.messages.ServerInputMessageType
          extended by be.SIRAPRISE.messages.EndTransactionMessageType
Direct Known Subclasses:
EndTransactionMessageTypeV1_0, EndTransactionMessageTypeV1_1

public abstract class EndTransactionMessageType
extends ServerInputMessageType

The EndTransactionMessageType is the type of message to be sent to the server to end a started transaction, either committing it or else rolling it back.

Author:
Erwin Smout

Field Summary
static int MESSAGETYPEID
          Comment for MESSAGETYPEID
 
Method Summary
 EndTransactionMessage message(boolean commit)
          Deprecated. replace with message() invocations including the transaction ID.
abstract  EndTransactionMessage message(boolean commit, long transactionID)
          Creates an EndTransaction message corresponding to the version of this message type, holding the given commit flag and transaction ID.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MESSAGETYPEID

public static final int MESSAGETYPEID
Comment for MESSAGETYPEID

See Also:
Constant Field Values
Method Detail

message

public final EndTransactionMessage message(boolean commit)
Deprecated. replace with message() invocations including the transaction ID.

Creates an EndTransaction message corresponding to the version of this message type, holding the given commit flag.

Parameters:
commit - true if the transaction to be ended must be committed, false if it is to be rolled back.
Returns:
an EndTransaction message corresponding to the version of this message type, holding the given commit flag.

message

public abstract EndTransactionMessage message(boolean commit,
                                              long transactionID)
Creates an EndTransaction message corresponding to the version of this message type, holding the given commit flag and transaction ID.

Parameters:
commit - true if the transaction to be ended must be committed, false if it is to be rolled back.
transactionID - The server-side ID of the transaction to be ended. Negative values indicate the "current" transaction, i.e. the lowest transaction in the current nested transaction structure.
Returns:
an EndTransaction message corresponding to the version of this message type, holding the given commit flag.