Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.reseller

Class CategoryTable

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.reseller.CategoryTable

All Implemented Interfaces:

Table<Category>, Iterable<Category>

public final class CategoryTable
extends CachedTableIntegerKey<Category>

Author:

AO Industries, Inc.

See Also:

Category, Ticket

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
Category	get(int pkey)
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
Table.TableID	getTableID()	Gets the unique identifier for this table.
Category	getTicketCategory(Category parent, String name)	Gets the category with the provided parent and name.
Category	getTicketCategoryByDotPath(String dotPath)	Gets a ticket category given its dot-separated path or null if not found.
List<Category>	getTopLevelCategories()	Gets the list of all top-level categories that have a null parent.
Tree<Category>	getTree()	Gets a Tree view of all the accessible categories.

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

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<Integer,Category>

Returns:

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

get

public Category get(int pkey)
             throws IOException,
                    SQLException

Specified by:

get in class CachedTableIntegerKey<Category>

Throws:

IOException

SQLException

See Also:

CachedTableIntegerKey.get(java.lang.Object)

getTopLevelCategories

public List<Category> getTopLevelCategories()
                                     throws IOException,
                                            SQLException

Gets the list of all top-level categories that have a null parent.

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

Returns:

the identifier for this table

See Also:

Table.TableID

getTicketCategory

public Category getTicketCategory(Category parent,
                                  String name)
                           throws IOException,
                                  SQLException

Gets the category with the provided parent and name. Parent may be null for top-level categories.

Throws:

IOException

SQLException

getTicketCategoryByDotPath

public Category getTicketCategoryByDotPath(String dotPath)
                                    throws IOException,
                                           SQLException

Gets a ticket category given its dot-separated path or null if not found.

Throws:

IOException

SQLException

getTree

public Tree<Category> getTree()

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