public interface Role extends DirectoryPrincipal
Roles may be assignable, which means that they can be explicitly assigned to users or organizations using the OrganizationalEntity.assignRole() method. The membership of an assignable role is the set of users and organizations to whom the role has been explicitly assigned.
Non-assignable roles, in contrast, have a membership that is determined dynamically based on the attributes of each User. The membership criteria are not accessible via this interface, and depend on the UserDirectory implementation.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
Modifier and Type | Method and Description |
---|---|
java.util.Collection |
getAccessRights()
Get all AccessRights that are associated with this role
|
java.util.Collection |
getAssigneeOrganizations()
Get all Organizations to which this assignable role is
explicitly assigned.
|
java.util.Collection |
getAssigneeOrganizationsSortOnName(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all Organizations to which this assignable role is explicitly
assigned, sorted on the name of the organization, with index control
of the result set returned as a collection.
|
java.util.Collection |
getAssignees()
Get all OrganizationalEntities to which this assignable role is
explicitly assigned.
|
java.util.Collection |
getAssigneeUsers()
Get all Users to which this assignable role is explicitly
assigned.
|
java.util.Collection |
getAssigneeUsersSortOnEmailAddress(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all Users to which this assignable role is explicitly
assigned, sorted on the emailAddress of the user, with index control
of the result set returned as a collection.
|
java.util.Collection |
getAssigneeUsersSortOnFirstName(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all Users to which this assignable role is explicitly
assigned, sorted on the firstName of the user, with index control
of the result set returned as a collection.
|
java.util.Collection |
getAssigneeUsersSortOnLastName(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all Users to which this assignable role is explicitly
assigned, sorted on the lastName of the user, with index control
of the result set returned as a collection.
|
java.util.Collection |
getAssigneeUsersSortOnLogin(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all Users to which this assignable role is explicitly
assigned, sorted on the login of the user, with index control
of the result set returned as a collection.
|
RoleFolder |
getParentFolder()
Get the parent RoleFolder of this Role, if it belongs to one.
|
java.util.Collection |
getTemplateRoles()
Get all template roles associated with this role.
|
boolean |
isAssignable()
Determine whether this Role may be explicitly assigned to a User
using assignRole().
|
boolean |
isAssignedTo(OrganizationalEntity pChild)
Determine whether an role is explicitly assigned to some
OrganizationalEntity.
|
void |
remove()
Remove this role from the user directory, from its parent
RoleFolder if any, and from any principals to which it is
assigned.
|
createRelativeRole, getDescription, getEffectivePrincipals, getMembers, getOrganizationMembersSortOnName, getPrimaryKey, getRelativeRole, getRelativeRoles, getUserDirectory, getUserMembersSortOnEmailAddress, getUserMembersSortOnFirstName, getUserMembersSortOnLastName, getUserMembersSortOnLogin, hasMember
static final java.lang.String CLASS_VERSION
boolean isAssignable()
OrganizationalEntity.assignRole(atg.userdirectory.Role)
RoleFolder getParentFolder()
java.util.Collection getAssignees()
java.util.Collection getAssigneeOrganizations()
java.util.Collection getAssigneeOrganizationsSortOnName(int pStartIndex, int pEndIndex, int pSortOrder)
pStartIndex
- starting index of the sorted result set.pEndEndex
- end index of the sorted result set. a value of -1 sets the end index to infinite.pSortOrder
- sort order of the return set.
valid values = { UserDirectory.ASCENDING, UserDirectory.DESCENDING }java.util.Collection getAssigneeUsersSortOnLogin(int pStartIndex, int pEndIndex, int pSortOrder)
pStartIndex
- starting index of the sorted result set.pEndEndex
- end index of the sorted result set. a value of -1 sets the end index to infinite.pSortOrder
- sort order of the return set.
valid values = { UserDirectory.ASCENDING, UserDirectory.DESCENDING }java.util.Collection getAssigneeUsersSortOnFirstName(int pStartIndex, int pEndIndex, int pSortOrder)
pStartIndex
- starting index of the sorted result set.pEndEndex
- end index of the sorted result set. a value of -1 sets the end index to infinite.pSortOrder
- sort order of the return set.
valid values = { UserDirectory.ASCENDING, UserDirectory.DESCENDING }java.util.Collection getAssigneeUsersSortOnLastName(int pStartIndex, int pEndIndex, int pSortOrder)
pStartIndex
- starting index of the sorted result set.pEndEndex
- end index of the sorted result set. a value of -1 sets the end index to infinite.pSortOrder
- sort order of the return set.
valid values = { UserDirectory.ASCENDING, UserDirectory.DESCENDING }java.util.Collection getAssigneeUsersSortOnEmailAddress(int pStartIndex, int pEndIndex, int pSortOrder)
pStartIndex
- starting index of the sorted result set.pEndEndex
- end index of the sorted result set. a value of -1 sets the end index to infinite.pSortOrder
- sort order of the return set.
valid values = { UserDirectory.ASCENDING, UserDirectory.DESCENDING }java.util.Collection getAssigneeUsers()
boolean isAssignedTo(OrganizationalEntity pChild)
pChild
- a principal representing a potential assignee of this
rolejava.util.Collection getAccessRights()
getAccessRights
in interface DirectoryPrincipal
java.util.Collection getTemplateRoles()
void remove() throws DirectoryModificationException
DirectoryModificationException
- occurs if the operation fails
unexpectedly; a nested exception provides details.