org.openmrs.web.dwr

Class DWRUserService

java.lang.Object

org.openmrs.web.dwr.DWRUserService

public class DWRUserService
extends Object

A collection of methods used by DWR for access users. These methods are similar to the UserService methods and have been chosen to be exposed via dwr to allow for access via javascript.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
DWRUserService()

Method Summary

Modifier and Type	Method and Description
Collection<UserListItem>	findUsers(String searchValue, List<String> rolesStrings, boolean includeVoided) Find users in the database that match the given search values.
Collection<UserListItem>	getAllUsers(List<String> roleStrings, boolean includeVoided)
UserListItem	getUser(Integer userId) Get the user identified by userId

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

DWRUserService

public DWRUserService()

Method Detail

findUsers

public Collection<UserListItem> findUsers(String searchValue,
                                          List<String> rolesStrings,
                                          boolean includeVoided)

Find users in the database that match the given search values.

Parameters:

searchValue - a query string like 'john doe'

rolesStrings - list of role names to restrict to like '[Provider, Manager]'

includeVoided - true/false to include voided users in the search

Returns:

list of UserListItems (or String warning message if none found)

See Also:

UserService.getUsers(String, List, boolean)

getAllUsers

public Collection<UserListItem> getAllUsers(List<String> roleStrings,
                                            boolean includeVoided)

getUser

public UserListItem getUser(Integer userId)

Get the user identified by userId

Parameters:

userId -

Returns:

found user item or, if the current user is not authenticated, a dummy user object