|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Organization
An Organization is a Principal representing an organization in the organizational graph of a user directory.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Method Summary | |
---|---|
boolean |
addChild(OrganizationalEntity pChild)
Add an organizational entity as a child of this organization. |
java.util.Collection |
getChildOrganizations()
Get all sub-organizations that are immediately contained in this organization. |
java.util.Collection |
getChildOrganizationsSortOnName(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all sub-organizations immediately contained in this organization, sorted on the name of the organization, with index control of the result set returned as a collection. |
java.util.Collection |
getChildren()
Get all users and sub-organizations that are immediately contained in this organization. |
java.util.Collection |
getChildUsers()
Get all users immediately contained in this organization. |
java.util.Collection |
getChildUsersSortOnEmailAddress(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all users immediately contained in this organization, sorted on the emailAddress of the user, with index control of the result set returned as a collection. |
java.util.Collection |
getChildUsersSortOnFirstName(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all users immediately contained in this organization, sorted on the firstName of the user, with index control of the result set returned as a collection. |
java.util.Collection |
getChildUsersSortOnLastName(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all users immediately contained in this organization, sorted on the lastName of the user, with index control of the result set returned as a collection. |
java.util.Collection |
getChildUsersSortOnLogin(int pStartIndex,
int pEndIndex,
int pSortOrder)
Get all users immediately contained in this organization, sorted on the login of the user, with index control of the result set returned as a collection. |
boolean |
hasChild(OrganizationalEntity pChild)
Determine whether an organization has some entity as an immediate child. |
boolean |
removeChild(OrganizationalEntity pChild)
Remove an organizational entity from this organization as a child. |
Methods inherited from interface atg.userdirectory.OrganizationalEntity |
---|
assignRole, getAncestorOrganizations, getAssignedRoles, getParentOrganization, hasAssignedRole, removeRole |
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 |
---|
java.util.Collection getChildren()
java.util.Collection getChildOrganizations()
java.util.Collection getChildOrganizationsSortOnName(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 getChildUsers()
java.util.Collection getChildUsersSortOnLogin(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 getChildUsersSortOnFirstName(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 getChildUsersSortOnLastName(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 getChildUsersSortOnEmailAddress(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 }
boolean hasChild(OrganizationalEntity pChild)
pChild
- a principal representing a potential child of that
organization
boolean addChild(OrganizationalEntity pChild) throws DirectoryModificationException
pChild
- a principal representing a user or sub-organization to be
added to the parent organization
DirectoryModificationException
- occurs if the operation fails
unexpectedly; a nested exception provides details.boolean removeChild(OrganizationalEntity pChild) throws DirectoryModificationException
pChild
- a principal representing a user or sub-organization to be
removed from the parent organization
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 |