|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OrganizationalEntity
An OrganizationalEntity is a Principal that can belong to an organization, in other words an Organization or a User.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Method Summary | |
---|---|
boolean |
assignRole(Role pRole)
Assign an existing assignable role to this OrganizationalEntity. |
java.util.List |
getAncestorOrganizations()
Get all the ancestor organizations that ultimately contain this OrganizationalEntity in a recursive sense. |
java.util.Collection |
getAssignedRoles()
Get the set of assignable roles which are explicitly assigned to this principal. |
Organization |
getParentOrganization()
Get the immediate parent organization which contains this OrganizationalEntity. |
boolean |
hasAssignedRole(Role pRole)
Determine whether a given assignable role is explicitly assigned to this principal. |
boolean |
removeRole(Role pRole)
Remove an existing assignable role from this OrganizationalEntity. |
Methods inherited from interface atg.userdirectory.DirectoryPrincipal |
---|
createRelativeRole, getAccessRights, getDescription, getEffectivePrincipals, getMembers, getOrganizationMembersSortOnName, getPrimaryKey, getRelativeRole, getRelativeRoles, getUserDirectory, getUserMembersSortOnEmailAddress, getUserMembersSortOnFirstName, getUserMembersSortOnLastName, getUserMembersSortOnLogin, hasMember |
Methods inherited from interface java.security.Principal |
---|
equals, getName, hashCode, toString |
Field Detail |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
Organization getParentOrganization()
java.util.List getAncestorOrganizations()
java.util.Collection getAssignedRoles()
Both global and relative roles are returned by this method.
boolean hasAssignedRole(Role pRole)
pRole
- a assignable role.
boolean assignRole(Role pRole) throws DirectoryModificationException
pRole
- a role to be assigned to this principal
DirectoryModificationException
- if the role is
not assignable or if the operation fails unexpectedly; a nested
exception provides details.
RoleNotAssignableException
- if the role is not assignable.boolean removeRole(Role pRole) throws DirectoryModificationException
pRole
- a role to be removed
DirectoryModificationException
- occurs if the operation fails
unexpectedly; a nested exception provides details.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |