Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.reseller

Class BrandTable

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.reseller.BrandTable

All Implemented Interfaces:

Table<Brand>, Iterable<Brand>

public final class BrandTable
extends CachedTableAccountNameKey<Brand>

Author:

AO Industries, Inc.

See Also:

Brand

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
Brand	get(Account.Name accounting)	Gets a Brand from the database.
Brand	getBrand(Account business)	Gets a Brand given its business.
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
Table.TableID	getTableID()	Gets the unique identifier for this table.
List<Brand>	getTopLevelBrands()	Gets the list of all brands that either have a null parent (the actual root of the business tree) or where the parent is inaccessible.
Tree<Brand>	getTree()	Gets a Tree view of all the accessible brands.

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

get

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, handleCommand, 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,Brand>

Returns:

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

get

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

Gets a Brand from the database.

Specified by:

get in class CachedTableAccountNameKey<Brand>

Throws:

IOException

SQLException

See Also:

CachedTableAccountNameKey.get(java.lang.Object)

getBrand

public Brand getBrand(Account business)
               throws IOException,
                      SQLException

Gets a Brand given its business.

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,Brand>

Returns:

the identifier for this table

See Also:

Table.TableID

getTopLevelBrands

public List<Brand> getTopLevelBrands()
                              throws IOException,
                                     SQLException

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

Throws:

IOException

SQLException

getTree

public Tree<Brand> getTree()

Gets a Tree view of all the accessible brands. 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