com.technia.tvc.core.db.model

Class UserInfo

java.lang.Object

com.technia.tvc.core.db.model.UserInfo

All Implemented Interfaces:

com.technia.tvc.core.db.model.SchemaInfo

public class UserInfo
extends java.lang.Object

Contains information about a user.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Returns true if the objects are equal.
static UserInfo	getInstance(java.lang.String name) Returns a UserInfo instance encapsulating information about the requested user.
java.lang.String	getName() Returns the name of the admin object.
static java.util.List<java.lang.String>	getPersonNames() Returns the names of all persons in the database.
static java.util.List<java.lang.String>	getUserNames() Returns an unmodifiable list containing the NAMES of all the users that exists in the database.
int	hashCode() Returns the objects hash code.
boolean	isGroup() Returns whether the user is a group or not.
boolean	isHidden() Returns whether the user is hidden or not.
boolean	isPerson() Returns whether the user is a person or not.
boolean	isRole() Returns whether the user is a role or not.
java.lang.String	toString() Returns a string representation suitable for debugging.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPersonNames

public static java.util.List<java.lang.String> getPersonNames()
                                                       throws TVCException

Returns the names of all persons in the database.

Returns:

The names of all persons in the database.

Throws:

TVCException - If an error occurs.

Since:

5.0.0

getInstance

public static UserInfo getInstance(java.lang.String name)
                            throws TVCException

Returns a UserInfo instance encapsulating information about the requested user.

Parameters:

name - The name of the user.

Returns:

A UserInfo instance.

Throws:

TVCException - If unable to retrieve user information in case the information has to be retrieved from the database.

isPerson

public boolean isPerson()

Returns whether the user is a person or not.

isRole

public boolean isRole()

Returns whether the user is a role or not.

isGroup

public boolean isGroup()

Returns whether the user is a group or not.

isHidden

public boolean isHidden()

Returns whether the user is hidden or not.

hashCode

public int hashCode()

Returns the objects hash code.

equals

public boolean equals(java.lang.Object o)

Returns true if the objects are equal.

getUserNames

public static java.util.List<java.lang.String> getUserNames()
                                                     throws TVCException

Returns an unmodifiable list containing the NAMES of all the users that exists in the database. The result of this operation will be cached, therefore - if new users are added at runtime, those will not be seen here unless the TVC Cache is refreshed.

Throws:

TVCException

getName

public java.lang.String getName()

Returns the name of the admin object.

Specified by:

getName in interface com.technia.tvc.core.db.model.SchemaInfo

toString

public final java.lang.String toString()

Returns a string representation suitable for debugging.

Overrides:

toString in class java.lang.Object