SubordinateTransactionControl (WildFly transaction client 1.0.0.Beta1 API)

```
public interface SubordinateTransactionControl
```
The control interface for subordinate transactions. This interface is used in the following cases:
- When a subordinate transaction is locally inflowed, an instance of this interface is used to control the lifecycle of the local transaction (the transaction's lifecycle methods are blocked in this case).
- The local handle for a subordinate transaction implements this interface.
Author:

David M. Lloyd

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`beforeCompletion()` Perform before-commit operations, including running all transaction synchronizations.
`void`	`commit(boolean onePhase)` Commit a transaction, either in a single phase or after a previous prepare.
`void`	`end(int flags)` End work on behalf of a transaction branch, disassociating the subordinate from the transaction branch.
`void`	`forget()` Forget the (previously prepared) transaction.
`int`	`getTransactionTimeout()` Get the estimated remaining timeout of the current branch.
`int`	`prepare()` Prepare the transaction.
`void`	`rollback()` Roll back the subordinate.

- Method Detail
  - rollback
```
void rollback()
       throws XAException
```
    Roll back the subordinate. In the event of error, the following error codes are possible:
    Throws:
    
    XAException - (with one of the above error codes) if an error occurs
  - end
```
void end(int flags)
  throws XAException
```
    End work on behalf of a transaction branch, disassociating the subordinate from the transaction branch. The flags parameter may equal one of the following:
    - XAResource.TMFAIL indicating that the transaction work has failed, and that the subordinate may mark the transaction as rollback-only
    - XAResource.TMSUCCESS indicating that the work has completed successfully and that a subsequent prepare() is likely
    In the event of error, the following error codes are possible:
    Parameters:
    
    flags - one of the valid flag values: TMSUSPEND, TMFAIL, or TMSUCCESS
    
    Throws:
    
    XAException - (with one of the above error codes) if an error occurs
  - beforeCompletion
```
void beforeCompletion()
               throws XAException
```
    Perform before-commit operations, including running all transaction synchronizations. In the event of an error, the following error codes are possible:
    Throws:
    
    XAException - (with one of the above error codes) if an error occurs
  - prepare
```
int prepare()
     throws XAException
```
    Prepare the transaction. If before-commit processing was not yet run, it is run. In the event of an error, the following error codes are possible:
    Returns:
    
    XAResource.XA_OK or XAResource.XA_RDONLY
    
    Throws:
    
    XAException - (with one of the above error codes) if an error occurs
  - forget
```
void forget()
     throws XAException
```
    Forget the (previously prepared) transaction. In the event of error, the following error codes are possible:
    Throws:
    
    XAException - (with one of the above error codes) if an error occurs
  - commit
```
void commit(boolean onePhase)
     throws XAException
```
    Commit a transaction, either in a single phase or after a previous prepare. In the event of error, the following error codes are possible:
    If the onePhase flag is true, one of the following error codes is also possible:
    Parameters:
    
    onePhase - true to commit in a single phase, false to commit after prepare
    
    Throws:
    
    XAException - (with one of the above error codes) if an error occurs
  - getTransactionTimeout
```
int getTransactionTimeout()
                   throws XAException
```
    Get the estimated remaining timeout of the current branch.
    
    Returns:
    
    the estimated remaining timeout of the current branch
    
    Throws:
    
    XAException

Interface SubordinateTransactionControl

Method Summary

Method Detail

rollback

end

beforeCompletion

prepare

forget

commit

getTransactionTimeout