Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.account

Class AccountTable

java.lang.Object

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

com.aoindustries.aoserv.client.CachedTable<Account.Name,V>

com.aoindustries.aoserv.client.account.CachedTableAccountNameKey<Account>

com.aoindustries.aoserv.client.account.AccountTable

All Implemented Interfaces:

Table<Account>, Iterable<Account>

public final class AccountTable
extends CachedTableAccountNameKey<Account>

Author:

AO Industries, Inc.

See Also:

Account

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
void	addAccount(Account.Name accounting, String contractNumber, Host defaultServer, Account.Name parent, boolean canAddBackupServers, boolean canAddAccounts, boolean canSeePrices, boolean billParent)
void	clearCache()	Clears the cache, freeing up memory.
Account.Name	generateAccountingCode(Account.Name template)
Account	get(Account.Name accounting)	Gets one Account from the database.
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
Account	getRootAccount()
Account.Name	getRootAccount_name()
Table.TableID	getTableID()	Gets the unique identifier for this table.
List<Account>	getTopLevelAccounts()	Gets the list of all accounts that either have a null parent (the actual root of the account tree) or where the parent is inaccessible.
Tree<Account>	getTree()	Gets a Tree view of all the accessible businesses.
boolean	handleCommand(String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)
boolean	isAccountingAvailable(Account.Name accounting)

Methods inherited from class com.aoindustries.aoserv.client.account.CachedTableAccountNameKey

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<Account.Name,Account>

Returns:

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

addAccount

public void addAccount(Account.Name accounting,
                       String contractNumber,
                       Host defaultServer,
                       Account.Name parent,
                       boolean canAddBackupServers,
                       boolean canAddAccounts,
                       boolean canSeePrices,
                       boolean billParent)
                throws IOException,
                       SQLException

Throws:

IOException

SQLException

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<Account.Name,Account>

generateAccountingCode

public Account.Name generateAccountingCode(Account.Name template)
                                    throws IOException,
                                           SQLException

Throws:

IOException

SQLException

get

public Account get(Account.Name accounting)
            throws IOException,
                   SQLException

Gets one Account from the database.

Specified by:

get in class CachedTableAccountNameKey<Account>

Throws:

IOException

SQLException

See Also:

CachedTableAccountNameKey.get(java.lang.Object)

getRootAccount_name

public Account.Name getRootAccount_name()
                                 throws IOException,
                                        SQLException

Throws:

IOException

SQLException

getRootAccount

public Account getRootAccount()
                       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<Account.Name,Account>

Returns:

the identifier for this table

See Also:

Table.TableID

getTopLevelAccounts

public List<Account> getTopLevelAccounts()
                                  throws IOException,
                                         SQLException

Gets the list of all accounts that either have a null parent (the actual root of the account tree) or where the parent is inaccessible.

Throws:

IOException

SQLException

handleCommand

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

Overrides:

handleCommand in class AOServTable<Account.Name,Account>

Throws:

IllegalArgumentException

SQLException

IOException

isAccountingAvailable

public boolean isAccountingAvailable(Account.Name accounting)
                              throws SQLException,
                                     IOException

Throws:

SQLException

IOException

getTree

public Tree<Account> getTree()

Gets a Tree view of all the accessible businesses. All access to the tree read-through to the underlying storage and are thus subject to change at any time. If you need a consistent snapshot of the tree, consider using TreeCopy.

See Also:

TreeCopy