org.jboss.tm.usertx.interfaces
Interface UserTransactionSession

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
UserTransactionSessionImpl (src)

public interface UserTransactionSession
extends java.rmi.Remote

The RMI remote UserTransaction session interface.


Method Summary
 java.lang.Object begin(int timeout)
          Start a new transaction, and return its TPC.
 void commit(java.lang.Object tpc)
          Commit the transaction.
 void destroy()
          Destroy this session.
 int getStatus(java.lang.Object tpc)
          Return status of the transaction.
 void rollback(java.lang.Object tpc)
          Rollback the transaction.
 void setRollbackOnly(java.lang.Object tpc)
          Mark the transaction for rollback only.
 

Method Detail

destroy

public void destroy()
             throws java.rmi.RemoteException
Destroy this session.

Throws:
java.rmi.RemoteException

begin

public java.lang.Object begin(int timeout)
                       throws java.rmi.RemoteException,
                              NotSupportedException (src) ,
                              SystemException (src) 
Start a new transaction, and return its TPC.

Parameters:
timeout - The timeout value for the new transaction, in seconds.
Returns:
The transaction propagation context for the new transaction.
Throws:
java.rmi.RemoteException
NotSupportedException (src)
SystemException (src)

commit

public void commit(java.lang.Object tpc)
            throws java.rmi.RemoteException,
                   RollbackException (src) ,
                   HeuristicMixedException (src) ,
                   HeuristicRollbackException (src) ,
                   java.lang.SecurityException,
                   java.lang.IllegalStateException,
                   SystemException (src) 
Commit the transaction.

Parameters:
tpc - The transaction propagation context for the transaction.
Throws:
java.rmi.RemoteException
RollbackException (src)
HeuristicMixedException (src)
HeuristicRollbackException (src)
java.lang.SecurityException
java.lang.IllegalStateException
SystemException (src)

rollback

public void rollback(java.lang.Object tpc)
              throws java.rmi.RemoteException,
                     java.lang.SecurityException,
                     java.lang.IllegalStateException,
                     SystemException (src) 
Rollback the transaction.

Parameters:
tpc - The transaction propagation context for the transaction.
Throws:
java.rmi.RemoteException
java.lang.SecurityException
java.lang.IllegalStateException
SystemException (src)

setRollbackOnly

public void setRollbackOnly(java.lang.Object tpc)
                     throws java.rmi.RemoteException,
                            java.lang.IllegalStateException,
                            SystemException (src) 
Mark the transaction for rollback only.

Parameters:
tpc - The transaction propagation context for the transaction.
Throws:
java.rmi.RemoteException
java.lang.IllegalStateException
SystemException (src)

getStatus

public int getStatus(java.lang.Object tpc)
              throws java.rmi.RemoteException,
                     SystemException (src) 
Return status of the transaction.

Parameters:
tpc - The transaction propagation context for the transaction.
Throws:
java.rmi.RemoteException
SystemException (src)