com.technia.tvc.core.db

Class PersonUtils

java.lang.Object

com.technia.tvc.core.db.PersonUtils

public final class PersonUtils
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static matrix.db.Context	cloneContext(matrix.db.Context context) Deprecated.
static void	error(java.lang.String message) Add a error client task to the matrix.db.Context.
static matrix.util.StringList	getAssignments() Returns the assignments for the context user.
static java.lang.String[]	getClientTasks() Returns the content of the users client task list as a string array.
static java.lang.String	getEmail() Returns the users email.
static java.lang.String	getFullname() Returns the users fullname.
static boolean	isAdministrator() Check if a user is an Administrator.
static boolean	isBusinessAdmin() Returns true if user is a business administrator.
static boolean	isSystemAdmin() Returns true if user is a system administrator.
static void	notice(java.lang.String message) Add a notice client task to the matrix.db.Context.
static void	reloadCacheForPerson(java.lang.String name)
static void	warning(java.lang.String message) Add a warning client task to the matrix.db.Context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

reloadCacheForPerson

public static void reloadCacheForPerson(java.lang.String name)
                                 throws TVCException

Parameters:

name - The name of the person whose cache will be reloaded.

Throws:

TVCException - If unable to successfully reload person information.

Since:

6.0.0

isSystemAdmin

public static boolean isSystemAdmin()
                             throws TVCException

Returns true if user is a system administrator.

Throws:

TVCException

isBusinessAdmin

public static boolean isBusinessAdmin()
                               throws TVCException

Returns true if user is a business administrator.

Throws:

TVCException

cloneContext

@Deprecated
public static matrix.db.Context cloneContext(matrix.db.Context context)
                                                  throws TVCException

Deprecated.

Throws:

TVCException

getAssignments

public static matrix.util.StringList getAssignments()

Returns the assignments for the context user.

Warning: this method will return an empty list if unable to retrieve the person's assignments from the database.

See Also:

PersonInfo.getAssignments()

getEmail

public static java.lang.String getEmail()

Returns the users email.

Warning: this method will return null if unable to retrieve the person's email from the database.

See Also:

PersonInfo.getEmail()

getFullname

public static java.lang.String getFullname()

Returns the users fullname.

Warning: this method will return null if unable to retrieve the person's fullname from the database.

See Also:

PersonInfo.getFullname()

getClientTasks

public static java.lang.String[] getClientTasks()

Returns the content of the users client task list as a string array. Useful in some cases when, for example a trigger blocks the modification of an attribute. If no client tasks were found this method returns null. Note: Only reasonErrorMsg, reasonNoticeMsg, and reasonErrorMsg client tasks are returned.

Returns:

The client task data.

notice

public static void notice(java.lang.String message)
                   throws TVCException

Add a notice client task to the matrix.db.Context.

Parameters:

message - the message.

Throws:

TVCException - if unable to add the client task.

warning

public static void warning(java.lang.String message)
                    throws TVCException

Add a warning client task to the matrix.db.Context.

Parameters:

message - the message.

Throws:

TVCException - if unable to add the client task.

error

public static void error(java.lang.String message)
                  throws TVCException

Add a error client task to the matrix.db.Context.

Parameters:

message - the message.

Throws:

TVCException - if unable to add the client task.

isAdministrator

public static boolean isAdministrator()
                               throws TVCException

Check if a user is an Administrator. A user is considered an Administrator if he or she is a business admin or system admin or if ht or she is assigned to the Administrator role in the application (What role is considered to be the administrator role is configurable as a TVCSystem property).

Returns:

Returns true if the user is an administrator.

Throws:

TVCException - If unable to check if the user is an administrator.

Since:

6.1.6