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.
|
Modifier and Type | Field and Description |
---|---|
static Role |
Profile.ADMINISTRATOR
Built-in 'Administrator' role.
|
static Role |
Profile.EVERYONE
Built-in role, all users have this role.
|
static Role |
Profile.OWNER
The dynamic built-in 'Owner' role.
|
static Role |
Profile.READ_ONLY
Built-in read-only role.
|
Modifier and Type | Method and 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.
|
Modifier and Type | Method and 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 . |
Modifier and Type | Method and Description |
---|---|
static ProcedureResult |
DirectoryDefaultHelper.deleteRole(Role aRole,
String aTrackingInfoOrNull,
DirectoryDefault aDirectory)
Deletes the role entity corresponding to the specified role.
|
String |
DirectoryHandler.displayBuiltInRole(Role aBuiltInRole,
Locale aLocale) |
String |
Directory.displayBuiltInRole(Role aBuiltInRole,
Locale aLocale)
Returns a label for the specified built-in role.
|
String |
DirectoryHandler.displaySpecificRole(Role aSpecificRole,
Locale aLocale) |
String |
DirectoryDefault.displaySpecificRole(Role aSpecificRole,
Locale aLocale) |
String |
Directory.displaySpecificRole(Role aSpecificRole,
Locale aLocale)
Returns a label for this specific role.
|
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 |
DirectoryHandler.getRoleEmail(Role aRole)
If not null, the email address is considered as the mailing list of all the users in this role.
|
String |
DirectoryDefault.getRoleEmail(Role aRole)
Returns the email address of the specified role.
|
String |
Directory.getRoleEmail(Role aRole)
Returns the email address of the specified role.
|
List<UserReference> |
DirectoryHandler.getUsersInRole(Role aRole) |
List<UserReference> |
DirectoryDefault.getUsersInRole(Role aRole) |
List<UserReference> |
Directory.getUsersInRole(Role aRole)
Returns all users that belong to the specified role.
|
boolean |
DirectoryHandler.isRoleStrictlyIncluded(Role aRole,
Role anotherRole)
Returns
true if aRole is included
in anotherRole . |
boolean |
DirectoryDefault.isRoleStrictlyIncluded(Role aRole,
Role anotherRole)
Returns true when aRole is included in anotherRole.
|
boolean |
Directory.isRoleStrictlyIncluded(Role aRole,
Role anotherRole)
Returns
true when aRole is included
in anotherRole . |
boolean |
DirectoryHandler.isSpecificRoleDefined(Role aSpecificRole) |
boolean |
DirectoryDefault.isSpecificRoleDefined(Role aRole) |
abstract boolean |
Directory.isSpecificRoleDefined(Role aSpecificRole)
Returns
true if the specific role exists in this
directory. |
boolean |
DirectoryHandler.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. |
abstract boolean |
Directory.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.
|
Modifier and Type | Method and 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.
|
Modifier and Type | Method and Description |
---|---|
Role |
UserTask.WorkItem.getOfferedTo()
Deprecated.
Since 5.7.0. This method is replaced by
UserTask.WorkItem.getOfferedToProfiles() . |
Role |
CreationWorkItemSpec.getOfferedTo()
Deprecated.
Since 5.7.0. This method is replaced by
CreationWorkItemSpec.getOfferedToProfiles() . |
Modifier and Type | Method and 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.
|