edu.emory.cci.aiw.cvrg.eureka.common.entity

Class UserEntity

java.lang.Object

edu.emory.cci.aiw.cvrg.eureka.common.entity.UserEntity

All Implemented Interfaces:

UserEntityVisitable, org.eurekaclinical.standardapis.entity.UserEntity<Role>

Direct Known Subclasses:

LdapUserEntity, LocalUserEntity, OAuthUserEntity

@Entity
public abstract class UserEntity
extends Object
implements org.eurekaclinical.standardapis.entity.UserEntity<Role>, UserEntityVisitable

A bean class to hold information about users in the system.

Author:

hrathod

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserEntity() Create an empty User object.
protected	UserEntity(LoginTypeEntity loginType, AuthenticationMethodEntity authenticationMethod)

Method Summary

Modifier and Type	Method and Description
AuthenticationMethodEntity	getAuthenticationMethod()
Date	getCreated()
String	getDepartment() Get the user's Department.
String	getEmail() Get the user's email address.
String	getFirstName() Get the user's first name.
String	getFullName()
Long	getId() Get the user's unique identifier.
Date	getLastLogin() Get the last log-in date for the user.
String	getLastName() Get the user's last name.
LoginTypeEntity	getLoginType()
String	getOrganization() Get the user's organization.
List<Role>	getRoles() Get all the roles assigned to the user.
String	getTitle() Get the user's title.
String	getUsername()
boolean	isActive() Get whether the user is active or not.
void	setActive(boolean inActive) Set whether the user is active or not.
void	setCreated(Date created)
void	setDepartment(String inDepartment) Set the user's Department.
void	setEmail(String inEmail) Set the user's email address.
void	setFirstName(String inFirstName) Set the user's first name.
void	setFullName(String fullName)
void	setId(Long inId) Set the user's unique identifier.
void	setLastLogin(Date inLastLogin) Set the user's last log-in date.
void	setLastName(String inLastName) Set the user's last name.
void	setOrganization(String inOrganization) Set the user's organization.
void	setRoles(List<Role> inRoles) Set the roles assigned to the current user.
void	setTitle(String inTitle) Set the user's title.
void	setUsername(String username)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.emory.cci.aiw.cvrg.eureka.common.entity.UserEntityVisitable

accept

Constructor Detail

UserEntity

protected UserEntity()

Create an empty User object.

UserEntity

protected UserEntity(LoginTypeEntity loginType,
                     AuthenticationMethodEntity authenticationMethod)

Method Detail

getId

public Long getId()

Get the user's unique identifier.

Specified by:

getId in interface org.eurekaclinical.standardapis.entity.UserEntity<Role>

Returns:

A Long representing the user's unique identifier.

setId

public void setId(Long inId)

Set the user's unique identifier.

Specified by:

setId in interface org.eurekaclinical.standardapis.entity.UserEntity<Role>

Parameters:

inId - A Long representing the user's unique identifier.

isActive

public boolean isActive()

Get whether the user is active or not.

Returns:

True if the user is active, false otherwise.

setActive

public void setActive(boolean inActive)

Set whether the user is active or not.

Parameters:

inActive - True if the user should be active, false otherwise.

getUsername

public String getUsername()

Specified by:

getUsername in interface org.eurekaclinical.standardapis.entity.UserEntity<Role>

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface org.eurekaclinical.standardapis.entity.UserEntity<Role>

getCreated

public Date getCreated()

setCreated

public void setCreated(Date created)

getFirstName

public String getFirstName()

Get the user's first name.

Returns:

A String containing the user's first name.

setFirstName

public void setFirstName(String inFirstName)

Set the user's first name.

Parameters:

inFirstName - A String containing the user's first name.

getLastName

public String getLastName()

Get the user's last name.

Returns:

A String containing the user's last name.

setLastName

public void setLastName(String inLastName)

Set the user's last name.

Parameters:

inLastName - A String containing the user's last name.

getFullName

public String getFullName()

setFullName

public void setFullName(String fullName)

getEmail

public String getEmail()

Get the user's email address.

Returns:

A String containing the user's email address.

setEmail

public void setEmail(String inEmail)

Set the user's email address.

Parameters:

inEmail - A String containing the user's email address.

getOrganization

public String getOrganization()

Get the user's organization.

Returns:

A String containing the user's organization.

setOrganization

public void setOrganization(String inOrganization)

Set the user's organization.

Parameters:

inOrganization - A String containing the user's organization.

getLastLogin

public Date getLastLogin()

Get the last log-in date for the user.

Returns:

The user's last log-in date, or null if the user has never logged in.

setLastLogin

public void setLastLogin(Date inLastLogin)

Set the user's last log-in date.

Parameters:

inLastLogin - The last log-in date for the user.

getRoles

public List<Role> getRoles()

Get all the roles assigned to the user.

Specified by:

getRoles in interface org.eurekaclinical.standardapis.entity.UserEntity<Role>

Returns:

A list of Role objects.

setRoles

public void setRoles(List<Role> inRoles)

Set the roles assigned to the current user.

Specified by:

setRoles in interface org.eurekaclinical.standardapis.entity.UserEntity<Role>

Parameters:

inRoles - A Set of roles to be assigned to the user.

getTitle

public String getTitle()

Get the user's title.

Returns:

The user's title.

setTitle

public void setTitle(String inTitle)

Set the user's title.

Parameters:

inTitle - The user's title.

getDepartment

public String getDepartment()

Get the user's Department.

Returns:

The user's Department.

setDepartment

public void setDepartment(String inDepartment)

Set the user's Department.

Parameters:

inDepartment - The user's department.

getLoginType

public LoginTypeEntity getLoginType()

getAuthenticationMethod

public AuthenticationMethodEntity getAuthenticationMethod()

toString

public String toString()

Overrides:

toString in class Object