# Uses of Class
com.orchestranetworks.service.Role

Packages that use Role
Package
Description
com.orchestranetworks.service
Provides classes and interfaces for implementing specific services and access rules on EBX®.
com.orchestranetworks.service.directory
Provides classes for Directory handling.
com.orchestranetworks.workflow
Provides classes and interfaces for implementing workflow processes and invoking them.

- ## Uses of Role in com.orchestranetworks.service

  Fields in com.orchestranetworks.service declared as Role
  Modifier and Type
  Field
  Description
  `static final Role`
  Profile.`ADMINISTRATOR`
  Built-in 'Administrator' role.
  `static final Role`
  Profile.`EVERYONE`
  Built-in role, all users have this role.
  `static final Role`
  Profile.`OWNER`
  The dynamic built-in 'Owner' role.
  `static final Role`
  Profile.`READ_ONLY`
  Built-in read-only role.
  Methods in com.orchestranetworks.service that return Role
  Modifier and Type
  Method
  Description
  `static Role`
  Profile.`forBuiltInRole(String roleName)`
  Returns the built-in role identified by the name specified.
  `static Role`
  Profile.`forSpecificRole(String roleName)`
  Returns the specific role identified by the name specified.

- ## Uses of Role in com.orchestranetworks.service.directory

  Methods in com.orchestranetworks.service.directory that return types with arguments of type Role
  Modifier and Type
  Method
  Description
  `List<Role>`
  DirectoryDefault.`getAllSpecificRoles()`
  Returns all the specific roles defined by this directory.
  `List<Role>`
  DirectoryDefault.RoleEntity.`getIncludedRoles()`
  Never returns `null`.
  `List<Role>`
  DirectoryDefault.`getRolesForUser(UserReference userReference)`
  Returns the specific roles of the specified user.
  `List<Role>`
  DirectoryDefault.UserEntity.`getSpecificRoles()`
  Never returns `null`.
  Methods in com.orchestranetworks.service.directory with parameters of type Role
  Modifier and Type
  Method
  Description
  `static ProcedureResult`
  DirectoryDefaultHelper.`deleteRole(Role aRole, String aTrackingInfoOrNull, DirectoryDefault aDirectory)`
  Deletes the role entity corresponding to the specified role.
  `String`
  Directory.`displayBuiltInRole(Role aBuiltInRole, Locale aLocale)`
  Returns a label for the specified built-in role.
  `String`
  DirectoryHandler.`displayBuiltInRole(Role aBuiltInRole, Locale aLocale)`
  `String`
  Directory.`displaySpecificRole(Role aSpecificRole, Locale aLocale)`
  Returns a label for this specific role.
  `String`
  DirectoryDefault.`displaySpecificRole(Role aSpecificRole, Locale aLocale)`
  `String`
  DirectoryHandler.`displaySpecificRole(Role aSpecificRole, Locale aLocale)`
  `static DirectoryDefault.RoleEntity`
  DirectoryDefaultHelper.`findRole(Role aRole, DirectoryDefault aDirectory)`
  Returns the role entity corresponding to the specified role if it exists, `null` otherwise.
  `String`
  DirectoryDefault.`getRoleDescription(Role aRole, Locale aLocale)`
  Returns the specific role description.
  `String`
  Directory.`getRoleEmail(Role aRole)`
  Returns the email address of the specified role.
  `String`
  DirectoryDefault.`getRoleEmail(Role aRole)`
  Returns the email address of the specified role.
  `String`
  DirectoryHandler.`getRoleEmail(Role aRole)`
  If not null, the email address is considered as the mailing list of all the users in this role.
  `List<UserReference>`
  Directory.`getUsersInRole(Role aRole)`
  Returns all users that belong to the specified role.
  `List<UserReference>`
  DirectoryDefault.`getUsersInRole(Role aRole)`
  `List<UserReference>`
  DirectoryHandler.`getUsersInRole(Role aRole)`
  `boolean`
  Directory.`hasUsersInRole(Role aRole)`
  Returns `true` if one or more users have the specified role.
  `boolean`
  DirectoryDefault.`hasUsersInRole(Role aRole)`
  `boolean`
  DirectoryHandler.`hasUsersInRole(Role aRole)`
  `boolean`
  Directory.`isRoleStrictlyIncluded(Role aRole, Role anotherRole)`
  Returns `true` when `aRole` is included in `anotherRole`.
  `boolean`
  DirectoryDefault.`isRoleStrictlyIncluded(Role aRole, Role anotherRole)`
  Returns true when aRole is included in anotherRole.
  `boolean`
  DirectoryHandler.`isRoleStrictlyIncluded(Role aRole, Role anotherRole)`
  Returns `true` if `aRole` is included in `anotherRole`.
  `abstract boolean`
  Directory.`isSpecificRoleDefined(Role aSpecificRole)`
  Returns `true` if the specific role exists in this directory.
  `boolean`
  DirectoryDefault.`isSpecificRoleDefined(Role aRole)`
  `boolean`
  DirectoryHandler.`isSpecificRoleDefined(Role aSpecificRole)`
  `abstract boolean`
  Directory.`isUserInRole(UserReference aUser, Role aRole)`
  Returns `true` if the user has the specified role.
  `boolean`
  DirectoryDefault.`isUserInRole(UserReference aUserReference, Role aRole)`
  Returns `true` if the user has the specified role.
  `boolean`
  DirectoryHandler.`isUserInRole(UserReference aUser, Role aRole)`
  Returns `true` if the user has the specified role.
  `static DirectoryDefault.RoleEntity`
  DirectoryDefaultHelper.`newRole(Role aRole)`
  Returns a new role entity whose key is the specified role.
  Method parameters in com.orchestranetworks.service.directory with type arguments of type Role
  Modifier and Type
  Method
  Description
  `void`
  DirectoryDefault.RoleEntity.`setIncludedRoles(List<Role> includedRoles)`
  Specifies the roles included in this role.
  `void`
  DirectoryDefault.UserEntity.`setSpecificRoles(List<Role> specificRoles)`
  Specifies the roles associated with the current user.

- ## Uses of Role in com.orchestranetworks.workflow

  Methods in com.orchestranetworks.workflow that return Role
  Modifier and Type
  Method
  Description
  `Role`
  CreationWorkItemSpec.`getOfferedTo()`
  Deprecated.
  Since 5.7.0.
  `Role`
  UserTask.WorkItem.`getOfferedTo()`
  Deprecated.
  Since 5.7.0.
  Methods in com.orchestranetworks.workflow with parameters of type Role
  Modifier and Type
  Method
  Description
  `static CreationWorkItemSpec`
  CreationWorkItemSpec.`forAllocationWithPossibleReallocation(UserReference allocatedTo, Role offeredTo)`
  Allows to create a work item allocated to the specified user with the possibility to reallocate it.
  `static CreationWorkItemSpec`
  CreationWorkItemSpec.`forOffer(Role offeredTo)`
  Allows to create a work item offered to the specified role.
  `List<UserTask.WorkItem>`
  WorkflowEngine.`getWorkItemsOfferedToRole(Role aRole)`
  Returns all the work items offered to a role.