org.openmrs.api.db

Interface UserDAO

All Known Implementing Classes:

HibernateUserDAO

public interface UserDAO

Database methods for the UserService

See Also:

Context, UserService

Method Summary

Modifier and Type	Method and Description
void	changeHashedPassword(User user, String hashedPassword, String salt)
void	changePassword(String pw, String pw2)
void	changePassword(User u, String pw)
void	changeQuestionAnswer(String pw, String q, String a)
void	changeQuestionAnswer(User u, String question, String answer)
void	deletePrivilege(Privilege privilege)
void	deleteRole(Role role)
void	deleteUser(User user)
Integer	generateSystemId()
List<Privilege>	getAllPrivileges()
List<Role>	getAllRoles()
List<User>	getAllUsers()
Integer	getCountOfUsers(String name, List<Role> roles, boolean includeRetired)
String	getLastLoginTime(User user)
LoginCredential	getLoginCredential(User user)
LoginCredential	getLoginCredentialByActivationKey(String activationKey) Gets User LoginCredential using activationKey
LoginCredential	getLoginCredentialByUuid(String uuid)
Privilege	getPrivilege(String p)
Privilege	getPrivilegeByUuid(String uuid)
Role	getRole(String r)
Role	getRoleByUuid(String uuid)
User	getUser(Integer userId)
User	getUserByEmail(String email)
User	getUserByUsername(String username)
User	getUserByUuid(String uuid)
List<User>	getUsers(String name, List<Role> roles, boolean includeRetired, Integer start, Integer length)
List<User>	getUsersByName(String givenName, String familyName, boolean includeVoided)
List<User>	getUsersByPerson(Person person, boolean includeRetired)
boolean	hasDuplicateUsername(String username, String systemId, Integer userId)
boolean	isSecretAnswer(User u, String answer)
Privilege	savePrivilege(Privilege privilege)
Role	saveRole(Role role)
User	saveUser(User user, String password)
void	setUserActivationKey(LoginCredential credentials)
void	updateLoginCredential(LoginCredential credential) Updates a user's login credentials.

Method Detail

saveUser

User saveUser(User user,
              String password)
       throws DAOException

Throws:

DAOException

See Also:

org.openmrs.api.UserService#saveUser(org.openmrs.User, java.lang.String)

getUser

User getUser(Integer userId)
      throws DAOException

Throws:

DAOException

See Also:

UserService.getUser(Integer)

getUserByUsername

User getUserByUsername(String username)
                throws DAOException

Throws:

DAOException

See Also:

UserService.getUserByUsername(java.lang.String)

getUserByEmail

User getUserByEmail(String email)

See Also:

org.openmrs.api.UserService#getUserByEmail(java.lang.String)

hasDuplicateUsername

boolean hasDuplicateUsername(String username,
                             String systemId,
                             Integer userId)
                      throws DAOException

Throws:

DAOException

See Also:

UserService.hasDuplicateUsername(org.openmrs.User)

deleteUser

void deleteUser(User user)
         throws DAOException

Throws:

DAOException

See Also:

UserService.purgeUser(org.openmrs.User)

getAllUsers

List<User> getAllUsers()
                throws DAOException

Throws:

DAOException

See Also:

UserService.getAllUsers()

saveRole

Role saveRole(Role role)
       throws DAOException

Throws:

DAOException

See Also:

UserService.saveRole(org.openmrs.Role)

deleteRole

void deleteRole(Role role)
         throws DAOException

Throws:

DAOException

See Also:

UserService.purgeRole(org.openmrs.Role)

getRole

Role getRole(String r)
      throws DAOException

Throws:

DAOException

See Also:

UserService.getRole(java.lang.String)

getAllRoles

List<Role> getAllRoles()
                throws DAOException

Throws:

DAOException

See Also:

UserService.getAllRoles()

savePrivilege

Privilege savePrivilege(Privilege privilege)
                 throws DAOException

Throws:

DAOException

See Also:

UserService.savePrivilege(org.openmrs.Privilege)

getPrivilege

Privilege getPrivilege(String p)
                throws DAOException

Throws:

DAOException

See Also:

UserService.getPrivilege(java.lang.String)

getAllPrivileges

List<Privilege> getAllPrivileges()
                          throws DAOException

Throws:

DAOException

See Also:

UserService.getAllPrivileges()

deletePrivilege

void deletePrivilege(Privilege privilege)
              throws DAOException

Throws:

DAOException

See Also:

UserService.purgePrivilege(org.openmrs.Privilege)

getUsersByName

List<User> getUsersByName(String givenName,
                          String familyName,
                          boolean includeVoided)

See Also:

UserService.getUsersByName(java.lang.String, java.lang.String, boolean)

changePassword

void changePassword(User u,
                    String pw)
             throws DAOException

Throws:

DAOException

See Also:

UserService.changePassword(org.openmrs.User, java.lang.String)

changePassword

void changePassword(String pw,
                    String pw2)
             throws DAOException

Throws:

DAOException

See Also:

UserService.changePassword(java.lang.String, java.lang.String)

changeHashedPassword

void changeHashedPassword(User user,
                          String hashedPassword,
                          String salt)
                   throws DAOException

Throws:

DAOException

See Also:

UserService.changeHashedPassword(User, String, String)

changeQuestionAnswer

void changeQuestionAnswer(User u,
                          String question,
                          String answer)
                   throws DAOException

Throws:

DAOException

See Also:

UserService.changeQuestionAnswer(User, String, String)

changeQuestionAnswer

void changeQuestionAnswer(String pw,
                          String q,
                          String a)
                   throws DAOException

Throws:

DAOException

See Also:

UserService.changeQuestionAnswer(java.lang.String, java.lang.String, java.lang.String)

isSecretAnswer

boolean isSecretAnswer(User u,
                       String answer)
                throws DAOException

Throws:

DAOException

See Also:

UserService.isSecretAnswer(org.openmrs.User, java.lang.String)

getPrivilegeByUuid

Privilege getPrivilegeByUuid(String uuid)

Parameters:

uuid -

Returns:

privilege or null

getRoleByUuid

Role getRoleByUuid(String uuid)

Parameters:

uuid -

Returns:

role or null

getUserByUuid

User getUserByUuid(String uuid)

Parameters:

uuid -

Returns:

user or null

getLoginCredential

LoginCredential getLoginCredential(User user)

Parameters:

user -

Returns:

The login credentials for a specified user.

getLoginCredentialByUuid

LoginCredential getLoginCredentialByUuid(String uuid)

Parameters:

uuid -

Returns:

login credential or null

updateLoginCredential

void updateLoginCredential(LoginCredential credential)

Updates a user's login credentials. Note that there is no createLoginCredential(LoginCredential) method. Login credentials are dependent on a User already existing.

Parameters:

credential -

getLoginCredentialByActivationKey

LoginCredential getLoginCredentialByActivationKey(String activationKey)

Gets User LoginCredential using activationKey

Parameters:

activationKey - User's activation key for password reset

Returns:

LoginCredentail associated with activationKey

generateSystemId

Integer generateSystemId()
                  throws DAOException

Throws:

DAOException

See Also:

UserService.generateSystemId()

getUsersByPerson

List<User> getUsersByPerson(Person person,
                            boolean includeRetired)

See Also:

UserService.getUsersByPerson(Person, boolean)

getUsers

List<User> getUsers(String name,
                    List<Role> roles,
                    boolean includeRetired,
                    Integer start,
                    Integer length)
             throws DAOException

Throws:

DAOException

See Also:

UserService.getUsers(String, List, boolean, Integer, Integer)

getCountOfUsers

Integer getCountOfUsers(String name,
                        List<Role> roles,
                        boolean includeRetired)

See Also:

UserService.getCountOfUsers(String, List, boolean)

setUserActivationKey

void setUserActivationKey(LoginCredential credentials)

See Also:

UserService#setUserActivationKey(LoginCredential)

getLastLoginTime

String getLastLoginTime(User user)

See Also:

UserService.getLastLoginTime(User)