Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.billing

Class TransactionTable

java.lang.Object

com.aoindustries.aoserv.client.AOServTable<K,V>

com.aoindustries.aoserv.client.CachedTable<Integer,V>

com.aoindustries.aoserv.client.CachedTableIntegerKey<Transaction>

com.aoindustries.aoserv.client.billing.TransactionTable

All Implemented Interfaces:

Table<Transaction>, Iterable<Transaction>

public final class TransactionTable
extends CachedTableIntegerKey<Transaction>

Author:

AO Industries, Inc.

See Also:

Transaction

Nested Class Summary

Nested classes/interfaces inherited from class com.aoindustries.aoserv.client.AOServTable

AOServTable.OrderBy

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.AOServTable

ASCENDING, connector, DESCENDING

Method Summary

Modifier and Type	Method	Description
int	add(int timeType, Timestamp time, Account account, Account sourceAccount, Administrator administrator, TransactionType type, String description, int quantity, Money rate, PaymentType paymentType, String paymentInfo, Processor processor, byte paymentConfirmed)
void	clearCache()	Clears the cache, freeing up memory.
Transaction	get(int transid)
List<Transaction>	get(TransactionSearchCriteria criteria)
Monies	getAccountBalance(Account account)
Monies	getAccountBalance(Account account, Timestamp before)
Monies	getActiveAccountBalance(Account account)
Monies	getActiveAccountBalance(Account account, long currentTime)	Gets the active account balances for an account, including zero balances for any currency that has no transactions and is currently active in billing.
Monies	getConfirmedAccountBalance(Account account)
Monies	getConfirmedAccountBalance(Account account, Timestamp before)
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
Table.TableID	getTableID()	Gets the unique identifier for this table.
Monies	getTransactionBalance(Transaction transaction)
List<Transaction>	getTransactions(Account account)	Gets transactions that have this account as their applied-to.
List<Transaction>	getTransactions(Administrator ba)
List<Transaction>	getTransactionsFrom(Account account)	Gets transactions that have this account as their source.
boolean	handleCommand(String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)

Methods inherited from class com.aoindustries.aoserv.client.CachedTableIntegerKey

get

Methods inherited from class com.aoindustries.aoserv.client.CachedTable

getIndexedRows, getRows, getRowsCopy, getUniqueRowImpl, isLoaded

Methods inherited from class com.aoindustries.aoserv.client.AOServTable

addProgressListener, addTableListener, addTableListener, addTableLoadListener, getCachedRowCount, getConnector, getDefaultOrderBySQLExpressions, getIndexedRows, getMap, getNewObject, getObject, getObjects, getObjects, getObjects, getObjectsNoProgress, getObjectsNoProgress, getSize, getSortAlgorithm, getTableName, getTableSchema, getUniqueRow, getUniqueRow, getUniqueRow, getUniqueRow, hasAnyTableListener, hasTableListener, isEmpty, iterator, printTable, removeProgressListener, removeTableListener, removeTableLoadListener, size, sortIfNeeded, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getDefaultOrderBy

protected AOServTable.OrderBy[] getDefaultOrderBy()

Description copied from class: AOServTable

Gets the default sorting for this table.

Specified by:

getDefaultOrderBy in class AOServTable<Integer,Transaction>

Returns:

null if the sorting is performed by the server or the array of column names

add

public int add(int timeType,
               Timestamp time,
               Account account,
               Account sourceAccount,
               Administrator administrator,
               TransactionType type,
               String description,
               int quantity,
               Money rate,
               PaymentType paymentType,
               String paymentInfo,
               Processor processor,
               byte paymentConfirmed)
        throws IOException,
               SQLException

Parameters:

timeType - Either Type.DATE (rounded to the date in Type.DATE_TIME_ZONE time zone) or Type.TIME, which maintains up to microsecond accuracy and is time zone agnostic.

time - The time of the transaction or null to use the current date / time per the master database clock. The master database server is both NTP-synchronized and actively monitored, so it is best to let the master database choose the time when "now" or "today" is desired for the transaction.

Throws:

IOException

SQLException

get

public Transaction get(int transid)
                throws IOException,
                       SQLException

Specified by:

get in class CachedTableIntegerKey<Transaction>

Throws:

IOException

SQLException

See Also:

CachedTableIntegerKey.get(java.lang.Object)

clearCache

public void clearCache()

Description copied from class: CachedTable

Clears the cache, freeing up memory. The data will be reloaded upon next use.

Overrides:

clearCache in class CachedTable<Integer,Transaction>

getAccountBalance

public Monies getAccountBalance(Account account)
                         throws IOException,
                                SQLException

Throws:

IOException

SQLException

getActiveAccountBalance

public Monies getActiveAccountBalance(Account account,
                                      long currentTime)
                               throws IOException,
                                      SQLException

Gets the active account balances for an account, including zero balances for any currency that has no transactions and is currently active in billing. A currency is active when any of the following is true:

1. Is part of the current monthly charges applied to the account (see Account.getCanceled() and Account.getBillingMonthlyRate()).
2. Has any existing transaction in the currency and any of the following:
   1. Account is active (see Account.getCanceled())
   2. Account canceled less than a year ago
   3. Account has a non-zero balance in the currency
   4. Account has a transaction in the currency within the last year

Throws:

IOException

SQLException

getActiveAccountBalance

public Monies getActiveAccountBalance(Account account)
                               throws IOException,
                                      SQLException

Throws:

IOException

SQLException

See Also:

getActiveAccountBalance(com.aoindustries.aoserv.client.account.Account, long), System.currentTimeMillis()

getAccountBalance

public Monies getAccountBalance(Account account,
                                Timestamp before)
                         throws IOException,
                                SQLException

Throws:

IOException

SQLException

getConfirmedAccountBalance

public Monies getConfirmedAccountBalance(Account account)
                                  throws IOException,
                                         SQLException

Throws:

IOException

SQLException

getConfirmedAccountBalance

public Monies getConfirmedAccountBalance(Account account,
                                         Timestamp before)
                                  throws IOException,
                                         SQLException

Throws:

IOException

SQLException

getTransactionBalance

public Monies getTransactionBalance(Transaction transaction)
                             throws IOException,
                                    SQLException

Throws:

IOException

SQLException

getTableID

public Table.TableID getTableID()

Description copied from class: AOServTable

Gets the unique identifier for this table. Each table has a unique identifier, as defined in SchemaTable.TableID.

Specified by:

getTableID in class AOServTable<Integer,Transaction>

Returns:

the identifier for this table

See Also:

Table.TableID

get

public List<Transaction> get(TransactionSearchCriteria criteria)
                      throws IOException,
                             SQLException

Throws:

IOException

SQLException

getTransactions

public List<Transaction> getTransactions(Account account)
                                  throws IOException,
                                         SQLException

Gets transactions that have this account as their applied-to.

Throws:

IOException

SQLException

getTransactionsFrom

public List<Transaction> getTransactionsFrom(Account account)
                                      throws IOException,
                                             SQLException

Gets transactions that have this account as their source.

Throws:

IOException

SQLException

getTransactions

public List<Transaction> getTransactions(Administrator ba)
                                  throws IOException,
                                         SQLException

Throws:

IOException

SQLException

handleCommand

public boolean handleCommand(String[] args,
                             Reader in,
                             TerminalWriter out,
                             TerminalWriter err,
                             boolean isInteractive)
                      throws IllegalArgumentException,
                             IOException,
                             SQLException

Overrides:

handleCommand in class AOServTable<Integer,Transaction>

Throws:

IllegalArgumentException

IOException

SQLException