PersonInfo (Technia Value Components (2023.2.0) API Documentation

java.lang.Object
- com.technia.tvc.core.db.model.PersonInfo

All Implemented Interfaces:

com.technia.tvc.core.db.model.SchemaInfo
```
public class PersonInfo
extends java.lang.Object
```
Contains information about a person.

Since:

4.0

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clearCache()` Clears the person cache completely.
`static void`	`clearCacheForPerson(java.lang.String name)` Clear the cached information for a particular person.
`static void`	`clearPersonNames()` Clear the cached list of persons in the system.
`boolean`	`equals(java.lang.Object obj)` Returns true if the objects are equal.
`static boolean`	`exists(java.lang.String name)` Returns true if the given person exists.
`static int`	`getActiveUserCount()`
`static java.util.List<PersonInfo>`	`getAllPersonInfos()` Returns all persons from the database.
`java.util.List<java.lang.String>`	`getAssignments()` Returns the assignments.
`java.lang.String`	`getEmail()` Returns the fullname.
`java.lang.String`	`getFullname()` Returns the fullname.
`static PersonInfo`	`getInstance()` Returns a `PersonInfo` instance encapsulating information about the current person.
`static PersonInfo`	`getInstance(java.lang.String name)` Returns a `PersonInfo` instance encapsulating information about the requested person.
`java.lang.String`	`getName()` Returns the name of the admin object.
`static java.util.Map<java.lang.String,java.lang.String>`	`getPersonFullNames()`
`static java.util.Map<java.lang.String,java.lang.String>`	`getPersonFullNames(java.util.List<java.lang.String> names)`
`static java.util.List<java.lang.String>`	`getPersonNames()` Returns an unmodifiable list containing the NAMES of all the persons that exists in the database.
`int`	`hashCode()` Returns the hash code.
`boolean`	`isBusiness()` Returns whether the person is a business or not.
`boolean`	`isFull()` Returns whether the person is a full or not.
`boolean`	`isHidden()` Returns whether the person is hidden or not.
`boolean`	`isInactive()` Returns whether the person is inactive or not.
`boolean`	`isSystem()` Returns whether the person is a system or not.
`static void`	`reloadCache()` Reloads the complete cache.
`static void`	`reloadCacheForPerson(java.lang.String name)` Reload the cache for a particular person.
`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
  - getActiveUserCount
```
public static int getActiveUserCount()
```
  - clearCache
```
public static void clearCache()
```
    Clears the person cache completely.
    
    Since:
    
    6.0.0
  - clearCacheForPerson
```
public static void clearCacheForPerson(java.lang.String name)
```
    Clear the cached information for a particular person.
    
    Parameters:
    
    name - The name of the person whose information should be cleared.
    
    Since:
    
    6.0.0
  - clearPersonNames
```
public static void clearPersonNames()
```
    Clear the cached list of persons in the system.
    
    Since:
    
    6.0.0
  - reloadCacheForPerson
```
public static void reloadCacheForPerson(java.lang.String name)
                                 throws TVCException
```
    Reload the cache for a particular person.
    
    Parameters:
    
    name - The name of the person whose information is reloaded.
    
    Throws:
    
    TVCException - If unable to reload the cached information.
    
    Since:
    
    6.0.0
  - reloadCache
```
public static void reloadCache()
                        throws TVCException
```
    Reloads the complete cache. The cache is reloaded in the way that we first reload the information and then we replace the old information with the new information. This way, if other threads are trying to get objects from the cache they can still access the old information until the new information is in place. This also means that other threads will not have to wait for the cache to reload.
    
    Throws:
    
    TVCException - If unable to reload the cache.
    
    Since:
    
    6.0.0
  - exists
```
public static boolean exists(java.lang.String name)
                      throws TVCException
```
    Returns true if the given person exists.
    
    Throws:
    
    TVCException
  - getPersonNames
```
public static java.util.List<java.lang.String> getPersonNames()
                                                       throws TVCException
```
    Returns an unmodifiable list containing the NAMES of all the persons that exists in the database. The result of this operation will be cached, therefore - if new persons are added at runtime, those will not be seen here unless the TVC Cache is refreshed.
    
    Throws:
    
    TVCException
  - getPersonFullNames
```
public static java.util.Map<java.lang.String,java.lang.String> getPersonFullNames()
                                                                           throws TVCException
```
    Throws:
    
    TVCException
  - getPersonFullNames
```
public static java.util.Map<java.lang.String,java.lang.String> getPersonFullNames(java.util.List<java.lang.String> names)
                                                                           throws TVCException
```
    Throws:
    
    TVCException
  - getAllPersonInfos
```
public static java.util.List<PersonInfo> getAllPersonInfos()
                                                    throws TVCException
```
    Returns all persons from the database.
    
    Throws:
    
    TVCException
  - getInstance
```
public static PersonInfo getInstance()
                              throws TVCException
```
    Returns a PersonInfo instance encapsulating information about the current person.
    
    Returns:
    
    A PersonInfo instance.
    
    Throws:
    
    TVCException - If unable to retrieve person information in case the information has to be retrieved from the database.
  - getInstance
```
public static PersonInfo getInstance(java.lang.String name)
                              throws TVCException
```
    Returns a PersonInfo instance encapsulating information about the requested person.
    
    Parameters:
    
    name - The name of the person.
    
    Returns:
    
    A PersonInfo instance.
    
    Throws:
    
    TVCException - If unable to retrieve person information in case the information has to be retrieved from the database.
  - isHidden
```
public boolean isHidden()
```
    Returns whether the person is hidden or not.
  - isInactive
```
public boolean isInactive()
```
    Returns whether the person is inactive or not.
  - isFull
```
public boolean isFull()
```
    Returns whether the person is a full or not.
  - isSystem
```
public boolean isSystem()
```
    Returns whether the person is a system or not.
  - isBusiness
```
public boolean isBusiness()
```
    Returns whether the person is a business or not.
  - getAssignments
```
public java.util.List<java.lang.String> getAssignments()
```
    Returns the assignments.
  - getFullname
```
public java.lang.String getFullname()
```
    Returns the fullname.
  - getEmail
```
public java.lang.String getEmail()
```
    Returns the fullname.
  - hashCode
```
public int hashCode()
```
    Returns the hash code.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true if the objects are equal.
  - 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

Class PersonInfo

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getActiveUserCount

clearCache

clearCacheForPerson

clearPersonNames

reloadCacheForPerson

reloadCache

exists

getPersonNames

getPersonFullNames

getPersonFullNames

getAllPersonInfos

getInstance

getInstance

isHidden

isInactive

isFull

isSystem

isBusiness

getAssignments

getFullname

getEmail

hashCode

equals

getName

toString