Uses of Class
org.openmrs.Role

Packages that use Role

Package	Description
org.openmrs	These classes represent the core domain objects for the OpenMRS project.
org.openmrs.api	The primary OpenMRS API interfaces.
org.openmrs.api.context	This package describes the context framework through which authentication is performed and services provided for the OpenMRS system.
org.openmrs.api.db	OpenMRS database layer interfaces.
org.openmrs.api.db.hibernate	Resources for Hibernate ORM.
org.openmrs.api.impl
org.openmrs.notification
org.openmrs.notification.impl
org.openmrs.web.controller.user

Uses of Role in org.openmrs

Methods in org.openmrs that return types with arguments of type Role

Modifier and Type	Method and Description
java.util.Set<Role>	Role.getAllChildRoles() Recursive (if need be) method to return all child roles of this role
java.util.Set<Role>	Role.getAllParentRoles() Recursive (if need be) method to return all parent roles of this role
java.util.Set<Role>	User.getAllRoles() Returns all roles attributed to this user by expanding the role list to include the parents of the assigned roles
java.util.Set<Role>	Role.getChildRoles()
java.util.Set<Role>	Role.getInheritedRoles()
java.util.Set<Role>	User.getRoles()
java.util.Set<Role>	Role.recurseOverChildren(java.util.Set<Role> total) Returns the full set of child roles be looping over children.
java.util.Set<Role>	Role.recurseOverParents(java.util.Set<Role> total) Returns the full set of roles be looping over inherited roles.

Methods in org.openmrs with parameters of type Role

Modifier and Type	Method and Description
User	User.addRole(Role role) Add the given Role to the list of roles for this User
User	User.removeRole(Role role) Remove the given Role from the list of roles for this User

Method parameters in org.openmrs with type arguments of type Role

Modifier and Type	Method and Description
java.util.Set<Role>	Role.recurseOverChildren(java.util.Set<Role> total) Returns the full set of child roles be looping over children.
java.util.Set<Role>	Role.recurseOverParents(java.util.Set<Role> total) Returns the full set of roles be looping over inherited roles.
void	Role.setChildRoles(java.util.Set<Role> childRoles)
void	Role.setInheritedRoles(java.util.Set<Role> inheritedRoles)
void	User.setRoles(java.util.Set<Role> roles)

Uses of Role in org.openmrs.api

Methods in org.openmrs.api that return Role

Modifier and Type	Method and Description
Role	UserService.getRole(java.lang.String r) Returns role object with given string role
Role	UserService.getRoleByUuid(java.lang.String uuid) Get Role by its UUID
Role	UserService.saveRole(Role role) Save the given role in the database

Methods in org.openmrs.api that return types with arguments of type Role

Modifier and Type	Method and Description
java.util.List<Role>	UserService.getAllRoles() Returns all roles currently possible for any User
java.util.List<Role>	UserService.getInheritingRoles(Role role) Deprecated. use getInheritedRoles()
java.util.List<Role>	UserService.getRoles() Deprecated. use UserService.getAllRoles()

Methods in org.openmrs.api with parameters of type Role

Modifier and Type	Method and Description
void	AdministrationService.createRole(Role role) Deprecated. see UserService.saveRole(Role)
void	AdministrationService.deleteRole(Role role) Deprecated. see UserService.purgeRole(Role)
java.util.List<Role>	UserService.getInheritingRoles(Role role) Deprecated. use getInheritedRoles()
java.util.List<User>	UserService.getUsersByRole(Role role) Get users by role granted
void	UserService.grantUserRole(User user, Role role) Deprecated. use User.addRole(Role)
void	UserService.purgeRole(Role role) Complete remove a role from the database
void	UserService.revokeUserRole(User user, Role role) Deprecated. use User.removeRole(Role)
Role	UserService.saveRole(Role role) Save the given role in the database
void	AdministrationService.updateRole(Role role) Deprecated. see UserService.saveRole(Role)

Method parameters in org.openmrs.api with type arguments of type Role

Modifier and Type	Method and Description
java.util.List<User>	UserService.getAllUsers(java.util.List<Role> roles, boolean includeVoided) Deprecated. use UserService.getUsers(String, List, boolean)
java.lang.Integer	UserService.getCountOfUsers(java.lang.String name, java.util.List<Role> roles, boolean includeRetired) Return the number of users with a matching name or system id and have at least one of the given roles assigned to them
java.util.List<User>	UserService.getUsers(java.lang.String nameSearch, java.util.List<Role> roles, boolean includeVoided) Return a list of users sorted by personName (see PersonByNameComparator) if any part of the search matches first/last/system id and the user has one at least one of the given roles assigned to them
java.util.List<User>	UserService.getUsers(java.lang.String name, java.util.List<Role> roles, boolean includeRetired, java.lang.Integer start, java.lang.Integer length) Return a batch of users of a specific size sorted by personName (see PersonByNameComparator) if any part of the search matches first/last/system id and the user has one at least one of the given roles assigned to them.

Uses of Role in org.openmrs.api.context

Methods in org.openmrs.api.context that return types with arguments of type Role

Modifier and Type	Method and Description
java.util.Set<Role>	UserContext.getAllRoles() Gets all the roles for the (un)authenticated user.
java.util.Set<Role>	UserContext.getAllRoles(User user) Gets all the roles for a user.
static java.util.Set<Role>	Context.getAllRoles(User user) Convenience method.

Uses of Role in org.openmrs.api.db

Methods in org.openmrs.api.db that return Role

Modifier and Type	Method and Description
Role	UserDAO.getRole(java.lang.String r)
Role	UserDAO.getRoleByUuid(java.lang.String uuid) Auto generated method comment
Role	UserDAO.saveRole(Role role)

Methods in org.openmrs.api.db that return types with arguments of type Role

Modifier and Type	Method and Description
java.util.List<Role>	UserDAO.getAllRoles()

Methods in org.openmrs.api.db with parameters of type Role

Modifier and Type	Method and Description
void	UserDAO.deleteRole(Role role)
Role	UserDAO.saveRole(Role role)

Method parameters in org.openmrs.api.db with type arguments of type Role

Modifier and Type	Method and Description
java.lang.Integer	UserDAO.getCountOfUsers(java.lang.String name, java.util.List<Role> roles, boolean includeRetired)
java.util.List<User>	UserDAO.getUsers(java.lang.String name, java.util.List<Role> roles, boolean includeRetired, java.lang.Integer start, java.lang.Integer length)

Uses of Role in org.openmrs.api.db.hibernate

Methods in org.openmrs.api.db.hibernate that return Role

Modifier and Type	Method and Description
Role	HibernateUserDAO.getRole(java.lang.String r)
Role	HibernateUserDAO.getRoleByUuid(java.lang.String uuid)
Role	HibernateUserDAO.saveRole(Role role)

Methods in org.openmrs.api.db.hibernate that return types with arguments of type Role

Modifier and Type	Method and Description
java.util.List<Role>	HibernateUserDAO.getAllRoles()

Methods in org.openmrs.api.db.hibernate with parameters of type Role

Modifier and Type	Method and Description
void	HibernateUserDAO.deleteRole(Role role)
java.util.List<User>	HibernateUserDAO.getUsersByRole(Role role)
Role	HibernateUserDAO.saveRole(Role role)

Method parameters in org.openmrs.api.db.hibernate with type arguments of type Role

Modifier and Type	Method and Description
java.lang.Integer	HibernateUserDAO.getCountOfUsers(java.lang.String name, java.util.List<Role> roles, boolean includeRetired)
java.util.List<User>	HibernateUserDAO.getUsers(java.lang.String name, java.util.List<Role> roles, boolean includeRetired, java.lang.Integer start, java.lang.Integer length)

Uses of Role in org.openmrs.api.impl

Methods in org.openmrs.api.impl that return Role

Modifier and Type	Method and Description
Role	UserServiceImpl.getRole(java.lang.String r)
Role	UserServiceImpl.getRoleByUuid(java.lang.String uuid)
Role	UserServiceImpl.saveRole(Role role)

Methods in org.openmrs.api.impl that return types with arguments of type Role

Modifier and Type	Method and Description
java.util.List<Role>	UserServiceImpl.getAllRoles()
java.util.List<Role>	UserServiceImpl.getInheritingRoles(Role role) Deprecated.
java.util.List<Role>	UserServiceImpl.getRoles() Deprecated.

Methods in org.openmrs.api.impl with parameters of type Role

Modifier and Type	Method and Description
void	AdministrationServiceImpl.createRole(Role role) Deprecated.
void	AdministrationServiceImpl.deleteRole(Role role) Deprecated.
java.util.List<Role>	UserServiceImpl.getInheritingRoles(Role role) Deprecated.
java.util.List<User>	UserServiceImpl.getUsersByRole(Role role)
void	UserServiceImpl.grantUserRole(User user, Role role) Deprecated.
void	UserServiceImpl.purgeRole(Role role)
void	UserServiceImpl.revokeUserRole(User user, Role role) Deprecated.
Role	UserServiceImpl.saveRole(Role role)
void	AdministrationServiceImpl.updateRole(Role role) Deprecated.

Method parameters in org.openmrs.api.impl with type arguments of type Role

Modifier and Type	Method and Description
java.util.List<User>	UserServiceImpl.getAllUsers(java.util.List<Role> roles, boolean includeVoided) Deprecated.
java.lang.Integer	UserServiceImpl.getCountOfUsers(java.lang.String name, java.util.List<Role> roles, boolean includeRetired)
java.util.List<User>	UserServiceImpl.getUsers(java.lang.String nameSearch, java.util.List<Role> roles, boolean includeVoided)
java.util.List<User>	UserServiceImpl.getUsers(java.lang.String name, java.util.List<Role> roles, boolean includeRetired, java.lang.Integer start, java.lang.Integer length)

Uses of Role in org.openmrs.notification

Methods in org.openmrs.notification with parameters of type Role

Modifier and Type	Method and Description
void	MessageService.send(Message message, Role role) Deprecated.
void	MessageService.sendMessage(Message message, Role role)

Uses of Role in org.openmrs.notification.impl

Methods in org.openmrs.notification.impl with parameters of type Role

Modifier and Type	Method and Description
void	MessageServiceImpl.send(Message message, Role role) Deprecated. MessageServiceImpl.send(Message, Role)
void	MessageServiceImpl.sendMessage(Message message, Role role) Sends a message to a group of users identifier by thir role.

Uses of Role in org.openmrs.web.controller.user

Methods in org.openmrs.web.controller.user that return types with arguments of type Role

Modifier and Type	Method and Description
java.util.List<Role>	UserFormController.getRoles(org.springframework.web.context.request.WebRequest request)

Methods in org.openmrs.web.controller.user with parameters of type Role

Modifier and Type	Method and Description
void	UserListController.displayUsers(org.springframework.ui.ModelMap model, java.lang.String action, java.lang.String name, Role role, java.lang.Boolean includeDisabled)
protected java.util.List<User>	UserListController.getUsers(java.lang.String action, java.lang.String name, Role role, java.lang.Boolean includeDisabled)