org.openmrs

Class User

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.User

All Implemented Interfaces:

Serializable, Attributable<User>, Auditable, Changeable, Creatable, OpenmrsObject, Retireable

@Entity
public class User
extends BaseOpenmrsObject
implements Serializable, Attributable<User>, Auditable, Retireable

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

Constructor Summary

Constructors

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

Method Summary

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	containsRole(String roleName) Checks if the user has a given role.
List<User>	findPossibleValues(String searchText) Deprecated.
Set<Role>	getAllRoles() Returns all roles attributed to this user by expanding the role list to include the parents of the assigned roles
User	getChangedBy()
User	getCreator()
Date	getDateChanged()
Date	getDateCreated()
Date	getDateRetired()
String	getDisplayString() Gets a descriptive String used for display purposes This is meant as an alternative to using the toString() to display this object to a user
String	getEmail()
String	getFamilyName() Get familyName on the Person this user account belongs to
String	getGivenName() Get givenName on the Person this user account belongs to
Integer	getId()
Set<PersonName>	getNames()
Person	getPerson()
PersonName	getPersonName()
List<User>	getPossibleValues() Deprecated.
Collection<Privilege>	getPrivileges() Get all privileges this user has.
List<Locale>	getProficientLocales() Returns a list of Locales for which the User is considered proficient.
Boolean	getRetired()
User	getRetiredBy()
String	getRetireReason()
Set<Role>	getRoles()
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.
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
User	hydrate(String userId) Deserialize the given string into a full object
Boolean	isRetired()
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.
String	serialize() Turn the current object into an identifying string that can be retrieved later
void	setChangedBy(User changedBy)
void	setCreator(User creator)
void	setDateChanged(Date dateChanged)
void	setDateCreated(Date dateCreated)
void	setDateRetired(Date dateRetired)
void	setEmail(String email)
void	setId(Integer id)
void	setPerson(Person person)
void	setRetired(Boolean retired)
void	setRetiredBy(User retiredBy)
void	setRetireReason(String retireReason)
void	setRoles(Set<Role> roles)
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() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, 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

containsRole

public boolean containsRole(String roleName)

Checks if the user has a given role. Role name comparisons are not case sensitive.

Parameters:

roleName - the name of the role to check

Returns:

true if the user has the given role, else false Should return true if the user has the given role Should return false if the user does not have the given role Should be case insensitive

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

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

findPossibleValues

@Deprecated
public List<User> findPossibleValues(String searchText)

Deprecated.

Description copied from interface: Attributable

Search for possible values of this object using the given search string

Specified by:

findPossibleValues in interface Attributable<User>

Parameters:

searchText - String to search on

Returns:

List of possible objects that can be assigned

See Also:

Attributable.findPossibleValues(java.lang.String)

getPossibleValues

@Deprecated
public List<User> getPossibleValues()

Deprecated.

Description copied from interface: Attributable

Find all possible values of this object. For example, if this object is a Location, the database is delved into and all Location objects should be returned

Specified by:

getPossibleValues in interface Attributable<User>

Returns:

List of objects that can be assigned

See Also:

Attributable.getPossibleValues()

hydrate

public User hydrate(String userId)

Description copied from interface: Attributable

Deserialize the given string into a full object

Specified by:

hydrate in interface Attributable<User>

Parameters:

userId - String to deserialize

Returns:

hydrated object

See Also:

Attributable.hydrate(java.lang.String)

serialize

public String serialize()

Description copied from interface: Attributable

Turn the current object into an identifying string that can be retrieved later

Specified by:

serialize in interface Attributable<User>

Returns:

String representing this object (Usually an identifier or primary key)

See Also:

Attributable.serialize()

getDisplayString

public String getDisplayString()

Description copied from interface: Attributable

Gets a descriptive String used for display purposes This is meant as an alternative to using the toString() to display this object to a user

Specified by:

getDisplayString in interface Attributable<User>

Returns:

String acceptable to display on a page

See Also:

Attributable.getDisplayString()

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.

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.

getEmail

public String getEmail()

Returns:

Returns the email.

Since:

2.2

setEmail

public void setEmail(String email)

Parameters:

email - The email to set.

Since:

2.2

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class BaseOpenmrsObject

getUserProperties

public Map<String,String> getUserProperties()

Returns:

Returns the userProperties.

setUserProperties

public void setUserProperties(Map<String,String> userProperties)

Parameters:

userProperties - A Map<String,String> 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()

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)

getCreator

public User getCreator()

Specified by:

getCreator in interface Creatable

Returns:

User - the user who created the object

setCreator

public void setCreator(User creator)

Specified by:

setCreator in interface Creatable

Parameters:

creator - - the user who created the object

getDateCreated

public Date getDateCreated()

Specified by:

getDateCreated in interface Creatable

Returns:

Date - the date the object was created

setDateCreated

public void setDateCreated(Date dateCreated)

Specified by:

setDateCreated in interface Creatable

Parameters:

dateCreated - - the date the object was created

getChangedBy

public User getChangedBy()

Specified by:

getChangedBy in interface Changeable

Returns:

User - the user who last changed the object

setChangedBy

public void setChangedBy(User changedBy)

Specified by:

setChangedBy in interface Changeable

Parameters:

changedBy - - the user who last changed the object

getDateChanged

public Date getDateChanged()

Specified by:

getDateChanged in interface Changeable

Returns:

Date - the date the object was last changed

setDateChanged

public void setDateChanged(Date dateChanged)

Specified by:

setDateChanged in interface Changeable

Parameters:

dateChanged - - the date the object was last changed

isRetired

public Boolean isRetired()

Specified by:

isRetired in interface Retireable

Returns:

Boolean - whether of not this object is retired

getRetired

public Boolean getRetired()

Specified by:

getRetired in interface Retireable

setRetired

public void setRetired(Boolean retired)

Specified by:

setRetired in interface Retireable

Parameters:

retired - - whether of not this object is retired

getRetiredBy

public User getRetiredBy()

Specified by:

getRetiredBy in interface Retireable

Returns:

User - the user who retired the object

setRetiredBy

public void setRetiredBy(User retiredBy)

Specified by:

setRetiredBy in interface Retireable

Parameters:

retiredBy - - the user who retired the object

getDateRetired

public Date getDateRetired()

Specified by:

getDateRetired in interface Retireable

Returns:

Date - the date the object was retired

setDateRetired

public void setDateRetired(Date dateRetired)

Specified by:

setDateRetired in interface Retireable

Parameters:

dateRetired - - the date the object was retired

getRetireReason

public String getRetireReason()

Specified by:

getRetireReason in interface Retireable

Returns:

String - the reason the object was retired

setRetireReason

public void setRetireReason(String retireReason)

Specified by:

setRetireReason in interface Retireable

Parameters:

retireReason - - the reason the object was retired