User (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsMetadata
  - - org.openmrs.User

All Implemented Interfaces:

Serializable, Auditable, OpenmrsMetadata, OpenmrsObject, Retireable
```
public class User
extends BaseOpenmrsMetadata
implements Serializable
```
Defines a User Account in the system. This account belongs to a Person in the system, although that person may have other user accounts. Users have login credentials (username/password) and can have special user properties. User properties are just simple key-value pairs for either quick info or display specific info that needs to be persisted (like locale preferences, search options, etc)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

User()
default constructor

User(Integer userId)
constructor with id

User(Person person)
constructor with person object

Constructors
Constructor and Description
`User()` default constructor
`User(Integer userId)` constructor with id
`User(Person person)` constructor with person object

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addName(PersonName name)`
`User`	`addRole(Role role)` Add the given Role to the list of roles for this User
`boolean`	`equals(Object obj)` Compares two objects for similarity
`Set<Role>`	`getAllRoles()` Returns all roles attributed to this user by expanding the role list to include the parents of the assigned roles
`String`	`getFamilyName()` Get familyName on the Person this user account belongs to
`String`	`getFirstName()` Deprecated. use `getGivenName` on `Person`
`String`	`getGivenName()` Get givenName on the Person this user account belongs to
`Integer`	`getId()`
`String`	`getLastName()` Deprecated. use `getFamilyName` on `Person`
`Set<PersonName>`	`getNames()`
`Person`	`getPerson()`
`PersonName`	`getPersonName()`
`Collection<Privilege>`	`getPrivileges()` Get all privileges this user has.
`List<Locale>`	`getProficientLocales()` Returns a list of Locales for which the User is considered proficient.
`Set<Role>`	`getRoles()`
`String`	`getSecretQuestion()`
`String`	`getSystemId()`
`Integer`	`getUserId()`
`String`	`getUsername()`
`Map<String,String>`	`getUserProperties()`
`String`	`getUserProperty(String prop)` Get prop property from this user's properties.
`String`	`getUserProperty(String prop, String defaultValue)` Get prop property from this user's properties.
`int`	`hashCode()` The hashcode for a user is used to index the objects in a tree
`boolean`	`hasPrivilege(String privilege)` This method shouldn't be used directly.
`boolean`	`hasRole(String r)` Check if this user has the given String role
`boolean`	`hasRole(String r, boolean ignoreSuperUser)` Checks if this user has the given String role
`boolean`	`isSuperUser()` Return true if this user has all privileges
`User`	`removeRole(Role role)` Remove the given Role from the list of roles for this User
`void`	`removeUserProperty(String prop)` Convenience method.
`User`	`replaceSerialization(Map<?,?> sessionMap)` If the serializer wishes, don't serialize this entire object, just the important parts
`void`	`setId(Integer id)`
`void`	`setPerson(Person person)`
`void`	`setPersonId(Integer personId)` Deprecated. see `setPerson(Person)`
`void`	`setRoles(Set<Role> roles)`
`void`	`setSecretQuestion(String secretQuestion)`
`void`	`setSystemId(String systemId)`
`void`	`setUserId(Integer userId)`
`void`	`setUsername(String username)`
`void`	`setUserProperties(Map<String,String> userProperties)`
`void`	`setUserProperty(String prop, String value)` Convenience method.
`String`	`toString()`
`void`	`validateSerialization(Map<?,?> sessionMap)`

Methods inherited from class org.openmrs.BaseOpenmrsMetadata
getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getDescription, getName, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setDescription, setName, setRetired, setRetiredBy, setRetireReason

Methods inherited from class org.openmrs.BaseOpenmrsObject
getUuid, setUuid

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject
getUuid, setUuid

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - User
```
public User()
```
    default constructor
  - User
```
public User(Integer userId)
```
    constructor with id
  - User
```
public User(Person person)
```
    constructor with person object
- Method Detail
  - isSuperUser
```
public boolean isSuperUser()
```
    Return true if this user has all privileges
    
    Returns:
    
    true/false if this user is defined as a super user
  - hasPrivilege
```
public boolean hasPrivilege(String privilege)
```
    This method shouldn't be used directly. Use org.openmrs.api.context.Context#hasPrivilege so that anonymous/authenticated/proxy privileges are all included Return true if this user has the specified privilege
    
    Parameters:
    
    privilege -
    
    Returns:
    
    true/false depending on whether user has specified privilege
  - hasRole
```
public boolean hasRole(String r)
```
    Check if this user has the given String role
    
    Parameters:
    
    r - String name of a role to check
    
    Returns:
    
    Returns true if this user has the specified role, false otherwise
  - hasRole
```
public boolean hasRole(String r,
                       boolean ignoreSuperUser)
```
    Checks if this user has the given String role
    
    Parameters:
    
    r - String name of a role to check
    
    ignoreSuperUser - If this is false, then this method will always return true for a superuser.
    
    Returns:
    
    Returns true if the user has the given role, or if ignoreSuperUser is false and the user is a superUser
  - getPrivileges
```
public Collection<Privilege> getPrivileges()
```
    Get all privileges this user has. This delves into all of the roles that a person has, appending unique privileges
    
    Returns:
    
    Collection of complete Privileges this user has
  - equals
```
public boolean equals(Object obj)
```
    Compares two objects for similarity
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    boolean true/false whether or not they are the same objects
  - hashCode
```
public int hashCode()
```
    The hashcode for a user is used to index the objects in a tree
    
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Person.hashCode()
  - getAllRoles
```
public Set<Role> getAllRoles()
```
    Returns all roles attributed to this user by expanding the role list to include the parents of the assigned roles
    
    Returns:
    
    all roles (inherited from parents and given) for this user
  - getRoles
```
public Set<Role> getRoles()
```
    Returns:
    
    Returns the roles.
  - setRoles
```
public void setRoles(Set<Role> roles)
```
    Parameters:
    
    roles - The roles to set.
  - addRole
```
public User addRole(Role role)
```
    Add the given Role to the list of roles for this User
    
    Parameters:
    
    role -
    
    Returns:
    
    Returns this user with the given role attached
  - removeRole
```
public User removeRole(Role role)
```
    Remove the given Role from the list of roles for this User
    
    Parameters:
    
    role -
    
    Returns:
    
    this user with the given role removed
  - getSystemId
```
public String getSystemId()
```
    Returns:
    
    Returns the systemId.
  - setSystemId
```
public void setSystemId(String systemId)
```
    Parameters:
    
    systemId - The systemId to set.
  - getUserId
```
public Integer getUserId()
```
    Returns:
    
    Returns the userId.
  - setUserId
```
public void setUserId(Integer userId)
```
    Parameters:
    
    userId - The userId to set.
  - setPersonId
```
@Deprecated
public void setPersonId(Integer personId)
```
    Deprecated. see setPerson(Person)
  - getPerson
```
public Person getPerson()
```
    Returns:
    
    the person
    
    Since:
    
    1.6
  - setPerson
```
public void setPerson(Person person)
```
    Parameters:
    
    person - the person to set
    
    Since:
    
    1.6
  - getUsername
```
public String getUsername()
```
    Returns:
    
    Returns the username.
  - setUsername
```
public void setUsername(String username)
```
    Parameters:
    
    username - The username to set.
  - getSecretQuestion
```
public String getSecretQuestion()
```
    Returns:
    
    Returns the secretQuestion.
  - setSecretQuestion
```
public void setSecretQuestion(String secretQuestion)
```
    Parameters:
    
    secretQuestion - The secretQuestion to set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getUserProperties
```
public Map<String,String> getUserProperties()
```
    Returns:
    
    Returns the userProperties.
  - setUserProperties
```
public void setUserProperties(Map<String,String> userProperties)
```
    Parameters:
    
    userProperties - A Map of the properties to set.
  - setUserProperty
```
public void setUserProperty(String prop,
                            String value)
```
    Convenience method. Adds the given property to the user's properties
  - removeUserProperty
```
public void removeUserProperty(String prop)
```
    Convenience method. Removes the given property from the user's properties
  - getUserProperty
```
public String getUserProperty(String prop)
```
    Get prop property from this user's properties. If prop is not found in properties, return empty string
    
    Parameters:
    
    prop -
    
    Returns:
    
    property value
  - getUserProperty
```
public String getUserProperty(String prop,
                              String defaultValue)
```
    Get prop property from this user's properties. If prop is not found in properties, return defaultValue
    
    Parameters:
    
    prop -
    
    defaultValue -
    
    Returns:
    
    property value
    
    See Also:
    
    getUserProperty(java.lang.String)
  - addName
```
public void addName(PersonName name)
```
    See Also:
    
    Person.addName(PersonName)
  - getPersonName
```
public PersonName getPersonName()
```
    See Also:
    
    Person.getPersonName()
  - getGivenName
```
public String getGivenName()
```
    Get givenName on the Person this user account belongs to
    
    See Also:
    
    Person.getGivenName()
  - getFamilyName
```
public String getFamilyName()
```
    Get familyName on the Person this user account belongs to
    
    See Also:
    
    Person.getFamilyName()
  - getNames
```
public Set<PersonName> getNames()
```
    See Also:
    
    Person.getNames()
  - getFirstName
```
@Deprecated
public String getFirstName()
```
    Deprecated. use getGivenName on Person
    
    Returns:
    
    String user's first name
  - getLastName
```
@Deprecated
public String getLastName()
```
    Deprecated. use getFamilyName on Person
    
    Returns:
    
    String user's last name
  - replaceSerialization
```
public User replaceSerialization(Map<?,?> sessionMap)
```
    If the serializer wishes, don't serialize this entire object, just the important parts
    
    Parameters:
    
    sessionMap - serialization session information
    
    Returns:
    
    User object to serialize
    
    See Also:
    
    OpenmrsUtil.isShortSerialization(Map)
  - validateSerialization
```
public void validateSerialization(Map<?,?> sessionMap)
```
  - getProficientLocales
```
public List<Locale> getProficientLocales()
```
    Returns a list of Locales for which the User is considered proficient.
    
    Returns:
    
    List of the User's proficient locales
  - getId
```
public Integer getId()
```
    Specified by:
    
    getId in interface OpenmrsObject
    
    Returns:
    
    id - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.getId()
  - setId
```
public void setId(Integer id)
```
    Specified by:
    
    setId in interface OpenmrsObject
    
    Parameters:
    
    id - - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.setId(java.lang.Integer)

Class User

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

Constructor Detail

User

User

User

Method Detail

isSuperUser

hasPrivilege

hasRole

hasRole

getPrivileges

equals

hashCode

getAllRoles

getRoles

setRoles

addRole

removeRole

getSystemId

setSystemId

getUserId

setUserId

setPersonId

getPerson

setPerson

getUsername

setUsername

getSecretQuestion

setSecretQuestion

toString

getUserProperties

setUserProperties

setUserProperty

removeUserProperty

getUserProperty

getUserProperty

addName

getPersonName

getGivenName

getFamilyName

getNames

getFirstName

getLastName

replaceSerialization

validateSerialization

getProficientLocales

getId

setId