API - User

The User class represents a user in the system and provides access to user information and group memberships.

Fields

Field	Type	Description
userId	String	User ID (login name)
language	String	User's language preference
lastName	String	Last (family) name
firstName	String	First or given name
department	String	Assigned department
phoneNumber	String	Phone number
email	String	Email address
info	String	Free text information
userGroups	List<String>	Assigned user groups

Getters

/**
 * @return the user ID (login name)
 */
String getUserId();

/**
 * 
 * @return the language preference of the user, e.g. "en" for English, "de" for German, etc.
 */
String getLanguage();

/**
 * 
 * @return the last (family) name of the user
 */
String getLastName();

/**
 * 
 * @return the first (given) name of the user
 */
String getFirstName();

/**
 * 
 * @return the department the user is assigned to. 
 *         If the user is not assigned to a department than null is returned.
 */
String getDepartment();

/**
 * 
 * @return the phone number of the user
 */
String getPhoneNumber();

/**
 * 
 * @return the email address of the user
 */
String getEmail();

/**
 * 
 * @return free text information filled by the user himself or by the administrator.
 */
String getInfo();

/**
 * 
 * @return the list of user groups the user is assigned to.
 */
List<String> getUserGroups();

/**
 * 
 * @param group the name of the user group to check membership for.
 * @return true if the user is a member of the specified group, false otherwise.
 */
boolean isInUserGroup(String group);