Transaction (sormula)

java.lang.Object
- org.sormula.Transaction

Direct Known Subclasses:

NoOpTransaction, OperationTransaction
```
public class Transaction
extends java.lang.Object
```
Simple transaction interface for Connection. This class is not required for most sormula programming and is only used by Database as a convenience. Other transaction mechanisms are compatible with sormula. This is required for cached tables.

Author:

Jeff Miller

Constructor Summary

Constructors
Constructor and Description

Transaction(java.sql.Connection connection)
Constructs for a connection.

Constructors
Constructor and Description
`Transaction(java.sql.Connection connection)` Constructs for a connection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(TransactionListener listener)` Adds a listener that will be notified of `Transaction` events.
`void`	`begin()` Starts the transaction.
`protected void`	`cleanUp()` Sets `isActive()` to false and restores auto commit to the original state.
`void`	`commit()` Commits the transaction by invoking `Connection.commit()`.
`java.sql.Connection`	`getConnection()` Gets the connection supplied in the constructor.
`protected java.util.List<TransactionListener>`	`getListeners()` Gets list of listeners that were added with `addListener(TransactionListener)`.
`boolean`	`isActive()` Reports if transaction is ongoing.
`protected void`	`notifyBegin()` Invokes `TransactionListener.begin(Transaction)` for all listeners.
`protected void`	`notifyCommit()` Invokes `TransactionListener.commit(Transaction)` for all listeners.
`protected void`	`notifyRollback()` Invokes `TransactionListener.rollback(Transaction)` for all listeners.
`void`	`removeListener(TransactionListener listener)` Removes a transaction listener.
`void`	`rollback()` Aborts the transaction by invoking `Connection.rollback()`.
`protected void`	`setActive(boolean active)` Sets the active indicator.
`void`	`setConnection(java.sql.Connection connection)` Sets new connection for transaction.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Transaction
```
public Transaction(java.sql.Connection connection)
```
    Constructs for a connection.
    
    Parameters:
    
    connection - JDBC connection
- Method Detail
  - getConnection
```
public java.sql.Connection getConnection()
```
    Gets the connection supplied in the constructor.
    
    Returns:
    
    connect for this transaction
  - setConnection
```
public void setConnection(java.sql.Connection connection)
                   throws SormulaException
```
    Sets new connection for transaction.
    Typically invoked by Database when a new connection is obtained. New connection is obtained after Database.close() is used followed by invoking a method that accesses the database.
    
    Parameters:
    
    connection - JDBC connection to use; null if connection has been closed
    
    Throws:
    
    SormulaException - if error
    
    Since:
    
    4.1
  - isActive
```
public boolean isActive()
```
    Reports if transaction is ongoing.
    
    Returns:
    
    true if begin() has been invoked but not commit() or rollback()
  - setActive
```
protected void setActive(boolean active)
```
    Sets the active indicator.
    
    Parameters:
    
    active - true if begin() was invoked but neither commit() nor rollback() has been invoked
    
    Since:
    
    3.0
  - begin
```
public void begin()
           throws SormulaException
```
    Starts the transaction.
    
    Throws:
    
    SormulaException - if error
  - commit
```
public void commit()
            throws SormulaException
```
    Commits the transaction by invoking Connection.commit().
    
    Throws:
    
    SormulaException - if error
  - rollback
```
public void rollback()
              throws SormulaException
```
    Aborts the transaction by invoking Connection.rollback().
    
    Throws:
    
    SormulaException - if error
  - addListener
```
public void addListener(TransactionListener listener)
```
    Adds a listener that will be notified of Transaction events.
    
    Parameters:
    
    listener - notify this class of transaction events
    
    Since:
    
    3.0
  - removeListener
```
public void removeListener(TransactionListener listener)
```
    Removes a transaction listener.
    
    Parameters:
    
    listener - listener to remove
    
    Since:
    
    3.0
  - getListeners
```
protected java.util.List<TransactionListener> getListeners()
```
    Gets list of listeners that were added with addListener(TransactionListener).
    
    Returns:
    
    list of transaction listeners
    
    Since:
    
    3.0
  - cleanUp
```
protected void cleanUp()
```
    Sets isActive() to false and restores auto commit to the original state.
  - notifyBegin
```
protected void notifyBegin()
```
    Invokes TransactionListener.begin(Transaction) for all listeners.
    
    Since:
    
    3.0
  - notifyCommit
```
protected void notifyCommit()
```
    Invokes TransactionListener.commit(Transaction) for all listeners.
    
    Since:
    
    3.0
  - notifyRollback
```
protected void notifyRollback()
```
    Invokes TransactionListener.rollback(Transaction) for all listeners.
    
    Since:
    
    3.0

Class Transaction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Transaction

Method Detail

getConnection

setConnection

isActive

setActive

begin

commit

rollback

addListener

removeListener

getListeners

cleanUp

notifyBegin

notifyCommit

notifyRollback