Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.billing

Class PackageTable

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.billing.PackageTable

All Implemented Interfaces:

Table<Package>, Iterable<Package>

public final class PackageTable
extends CachedTableIntegerKey<Package>

Author:

AO Industries, Inc.

See Also:

Package

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	addPackage(Account.Name name, Account business, PackageDefinition packageDefinition)
Account.Name	generatePackageName(Account.Name template)
Package	get(int pkey)
Package	get(Account.Name name)
Package	get(Object pkey)	Deprecated. Always try to lookup by specific keys; the compiler will help you more when types change.
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
List<Package>	getPackages(Account business)
Table.TableID	getTableID()	Gets the unique identifier for this table.
boolean	handleCommand(String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)
boolean	isPackageNameAvailable(Account.Name packageName)

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

clearCache, 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,Package>

Returns:

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

addPackage

public int addPackage(Account.Name name,
                      Account business,
                      PackageDefinition packageDefinition)
               throws IOException,
                      SQLException

Throws:

IOException

SQLException

get

@Deprecated
public Package get(Object pkey)
            throws IOException,
                   SQLException

Deprecated.

Always try to lookup by specific keys; the compiler will help you more when types change.

Supports both Integer (id) and Account.Name (name) keys.

Overrides:

get in class CachedTableIntegerKey<Package>

Parameters:

pkey - when null, will always return null

Throws:

IOException

SQLException

get

public Package get(int pkey)
            throws IOException,
                   SQLException

Specified by:

get in class CachedTableIntegerKey<Package>

Throws:

IOException

SQLException

See Also:

get(java.lang.Object)

get

public Package get(Account.Name name)
            throws IOException,
                   SQLException

Throws:

IOException

SQLException

See Also:

get(java.lang.Object)

generatePackageName

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

Throws:

IOException

SQLException

getPackages

public List<Package> getPackages(Account business)
                          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,Package>

Returns:

the identifier for this table

See Also:

Table.TableID

handleCommand

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

Overrides:

handleCommand in class AOServTable<Integer,Package>

Throws:

IllegalArgumentException

SQLException

IOException

isPackageNameAvailable

public boolean isPackageNameAvailable(Account.Name packageName)
                               throws SQLException,
                                      IOException

Throws:

SQLException

IOException