Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.account

Class UserTable

java.lang.Object

com.aoindustries.aoserv.client.AoservTable<User.Name,User>

com.aoindustries.aoserv.client.CachedTable<User.Name,User>

com.aoindustries.aoserv.client.account.CachedTableUserNameKey<User>

com.aoindustries.aoserv.client.account.UserTable

All Implemented Interfaces:

Table<User>, Iterable<User>

public final class UserTable
extends CachedTableUserNameKey<User>

Author:

AO Industries, Inc.

See Also:

• User

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	addUsername(Package packageObject, User.Name username)
User	get(User.Name username)
protected AoservTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
Table.TableId	getTableId()	Gets the unique identifier for this table.
List<User>	getUsernames(Package pack)
boolean	handleCommand(String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)
boolean	isUsernameAvailable(User.Name username)

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

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

getDefaultOrderBy

protected AoservTable.OrderBy[] getDefaultOrderBy()

Description copied from class: AoservTable

Gets the default sorting for this table.

Specified by:

getDefaultOrderBy in class AoservTable<User.Name,User>

Returns:

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

addUsername

public void addUsername(Package packageObject,
 User.Name username)
                 throws IOException,
SQLException

Throws:

IOException

SQLException

get

public User get(User.Name username)
         throws IOException,
SQLException

Specified by:

get in class CachedTableUserNameKey<User>

Throws:

IOException

SQLException

See Also:

• CachedTableUserNameKey.get(java.lang.Object)

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

Returns:

the identifier for this table

See Also:

• Table.TableId

getUsernames

public List<User> getUsernames(Package pack)
                        throws IOException,
SQLException

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

Throws:

IllegalArgumentException

SQLException

IOException

isUsernameAvailable

public boolean isUsernameAvailable(User.Name username)
                            throws SQLException,
IOException

Throws:

SQLException

IOException