|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OrganizationHierarchy
Interface for the Hierarchy object representing a Hierarchy of organizations.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
Organization |
createOrganization(java.lang.String parentOrganizationPath,
java.lang.String delimiter,
java.lang.String pathValue)
Returns a new organization object. |
Organization |
createOrganization(java.lang.String parentOrganizationPath,
java.lang.String delimiter,
java.lang.String pathValue,
java.lang.String primaryKeyValue)
Returns a new organization object. |
Schedule |
deleteAsynchronous()
Schedules a delete of this hierarchy. |
AccessControlGroup |
getAccessControlGroup()
Returns the Access Control Group for this hierarchy |
AttributeDefinition |
getDisplayAttribute()
Returns the display attribute for this hierarchy |
java.lang.String |
getName()
Retrieves the name of this hierarchy. |
Organization |
getOrganizationByPath(java.lang.String path)
Retrieves a Organization based upon Path name |
Organization |
getOrganizationByPath(java.lang.String path,
java.lang.String delimiter)
Retrieves a Organization based upon Path name |
Organization |
getOrganizationByPrimaryKey(java.lang.String primaryKey)
Retrieves a Organization based upon Primary key |
PIMCollection<Organization> |
getOrganizations()
Retrieves a collection of all the Organization objects in this hierarchy. |
PIMCollection<Organization> |
getOrganizationsAtLevel(int level)
Retrieves a collection of all the Organization objects in this hierarchy residing at a particular level. |
java.util.Collection<Organization> |
getOrganizationsByPaths(java.util.Collection<java.lang.String> paths)
Retrieves a collection of all the Organization objects in this hierarchy based upon their path names. |
java.util.Collection<Organization> |
getOrganizationsByPaths(java.util.Collection<java.lang.String> paths,
java.lang.String delimiter)
Retrieves a collection of all the Organization objects in this hierarchy based upon their path names. |
PIMCollection<Organization> |
getOrganizationsWithAttributeValue(java.lang.String attributeInstancePath,
java.lang.Object attributeValue)
Retrieves a collection of all the Organization objects in this hierarchy based upon a particular attribute value. |
AttributeDefinition |
getPathAttribute()
Returns the path attribute for this hierarchy |
PrimarySpec |
getPrimarySpec()
Retrieves the Primary spec for this hierarchy. |
Organization |
getRootOrganization()
Returns the root organization for this Hierarchy |
Sequence |
getSequence(AttributeDefinition sequenceAttribute)
gets the sequence object for the sequence attribute. |
AttributeCollection |
getUserDefinedAttributeCollection()
Retrieves the User Defined Core Attribute Collection for this hierarchy |
java.util.List<ValidationErrors> |
save()
Persist the changes to the given hierarchy object |
void |
setAccessControlGroup(AccessControlGroup acg)
Sets the Access Control Group for this hierarchy |
void |
setDisplayAttribute(AttributeDefinition attribute)
Set the attribute to be used as the display attribute for the hierarchy |
void |
setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
Associate the User defined Core Attribute collection with the hierarchy |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
Organization createOrganization(java.lang.String parentOrganizationPath, java.lang.String delimiter, java.lang.String pathValue)
parentOrganizationPath
- The path of the parent organization excluding the root name.delimiter
- The delimiter used in the provided parent Path. The delimiter
consists of all characters in the delmiter string taken
together.pathValue
- The value for the path attribute of the organization.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ADD_HIERARCHY_NODES
PIMInvalidPathException
- If the parent Path does not exist.
java.lang.IllegalArgumentException
- if any of the parameters is null or if delimiter or pathValue
is emptyOrganization createOrganization(java.lang.String parentOrganizationPath, java.lang.String delimiter, java.lang.String pathValue, java.lang.String primaryKeyValue)
parentOrganizationPath
- The path of the parent organization excluding the root name.delimiter
- The delimiter used in the provided parent Path. The delimiter
consists of all characters in the delmiter string taken
together.pathValue
- The value for the path attribute of the organization.primaryKeyValue
- Primary key value for the organization
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ADD_HIERARCHY_NODES
PIMInvalidPathException
- If the parent Path does not exist.
java.lang.IllegalArgumentException
- if any of the parameters is null or if delimiter, pathValue
or primaryKeyValue is emptySchedule deleteAsynchronous()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_DELETE
AccessControlGroup getAccessControlGroup()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
PIMCollection<Organization> getOrganizations()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
for more info
PIMCollection<Organization> getOrganizationsWithAttributeValue(java.lang.String attributeInstancePath, java.lang.Object attributeValue)
attributeInstancePath
- The Path of the attributeattributeValue
- The Value of the attribute instance.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
PIMInvalidPathException
- If the given attribute path does not exist.
java.lang.IllegalArgumentException
- if any of the parameters is null, or if attributeInstancePath
is emptyfor more info
PIMCollection<Organization> getOrganizationsAtLevel(int level)
level
- the level in the hierarchy for which organizations to be
returned. Level 1 will return all the organizations under
root.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- If the passed in level is not a positive non-zero number.for more info
java.util.Collection<Organization> getOrganizationsByPaths(java.util.Collection<java.lang.String> paths)
paths
- Organization paths excluding the root organization name
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.util.Collection<Organization> getOrganizationsByPaths(java.util.Collection<java.lang.String> paths, java.lang.String delimiter)
paths
- Organization paths excluding the root organization namedelimiter
- The delimiter used in the provided paths.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is null or if delimiter is emptyOrganization getOrganizationByPath(java.lang.String path)
path
- organization path excluding the root organization name
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if path is nullOrganization getOrganizationByPath(java.lang.String path, java.lang.String delimiter)
path
- organization path excluding the root organization namedelimiter
- the delimiter used in the provided path, or null if an
organization with the given path is not found
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is null or if delimiter is emptyOrganization getOrganizationByPrimaryKey(java.lang.String primaryKey)
primaryKey
- primary key
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if primaryKey is null or emptyAttributeDefinition getDisplayAttribute()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.String getName()
PIMInternalException
- If an internal error occursAttributeDefinition getPathAttribute()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
PrimarySpec getPrimarySpec()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
Organization getRootOrganization()
PIMInternalException
- if an internal exception occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
AttributeCollection getUserDefinedAttributeCollection() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
Sequence getSequence(AttributeDefinition sequenceAttribute)
sequenceAttribute
- the sequence attribute definition.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- If the passed argument is nulljava.util.List<ValidationErrors> save()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
void setAccessControlGroup(AccessControlGroup acg)
acg
- The access control group to associate with a hierarchy
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
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 setDisplayAttribute(AttributeDefinition attribute)
attribute
- an attribute
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
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 setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
attributeCollection
- an attribute collection
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
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 |