|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Organization
Interface for Organization object. Organization belongs to an OrganizationHierarchy and groups users.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
addChild(Organization childOrganization)
Adds a organization as a child of this organization. |
void |
associateUser(User user)
Associates a user with this Organization. |
void |
delete()
Deletes the given organization. |
void |
disassociateUser(User user)
Disassociate a user from this Organization. |
java.util.Collection<Organization> |
getChildren()
Returns the categories immediately below this organization. |
PIMCollection<Organization> |
getDescendents()
Returns all the descendents of this organization. |
java.lang.String |
getDisplayName()
Returns the name of this Category object |
java.util.Collection<java.lang.String> |
getFullPaths(boolean includeRootName)
Returns the full name paths of this Organization. |
java.util.Collection<java.lang.String> |
getFullPaths(java.lang.String delimiter,
boolean includeRootName)
Returns the full name paths of this Organization. |
OrganizationHierarchy |
getHierarchy()
Returns the OrganiztionHierarchy object containing this Organization object. |
int[] |
getLevels()
Returns the levels of this organization in an array of Integers. |
Organization |
getParent()
Returns this organization's parent. |
java.util.Collection<Organization> |
getParents()
Returns the parent categories of the given Organization. |
PIMCollection<User> |
getUsers()
Returns a collection of users belonging to this Organization |
boolean |
hasChildren()
Determines if the given organization has any children. |
boolean |
isRoot()
Identifies whether this Organization is the root Organization of the OrganizationHierarchy it lives within |
void |
removeChild(Organization childOrganization)
Remove the given child Organization from this organization's children. |
ValidationErrors |
validate()
Validates the organization. |
Methods inherited from interface com.ibm.pim.attribute.AttributeOwner |
---|
getAttributeChangesComparedTo, getAttributeChangesSinceLastSave, getAttributeInstance, getAttributeValue, getOriginalAttributeOwner, getRootAttributeInstance, getRootAttributeInstances, getSpecs, isComparable, setAttributeValue |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
void associateUser(User user)
user
- User to associate with
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is nullvoid disassociateUser(User user)
user
- User to disassociate with
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is nullPIMCollection<User> getUsers()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.java.lang.String getDisplayName() throws PIMInternalException
PIMInternalException
- if an internal error occursvoid addChild(Organization childOrganization)
childOrganization
- the organization to be added as a child
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_RECATEGORIZE_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.void delete()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_DELETE_HIERARCHY_NODES
java.lang.UnsupportedOperationException
- if this is a root organizationjava.util.Collection<Organization> getChildren()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- reserved for future usePIMCollection<Organization> getDescendents()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- reserved for future usejava.util.Collection<java.lang.String> getFullPaths(boolean includeRootName)
includeRootName
- If true, the returned full paths include the root organization
name.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usejava.util.Collection<java.lang.String> getFullPaths(java.lang.String delimiter, boolean includeRootName)
delimiter
- The delimiter to be used in the full paths that are returned.includeRootName
- If true, the returned full paths include the root organization
name.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- if any of the parameters is nullOrganizationHierarchy getHierarchy()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- Reserved for future useint[] getLevels()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useOrganization getParent()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.UnsupportedOperationException
- if this is a root organizationjava.util.Collection<Organization> getParents()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.UnsupportedOperationException
- if this is a root organizationboolean hasChildren()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useboolean isRoot()
PIMInternalException
- if an internal error occursValidationErrors validate()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- reserved for future usevoid removeChild(Organization childOrganization)
childOrganization
- the child organization to remove.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_RECATEGORIZE_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |