Interface OrganizationHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OrganizationHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Organization objects. Each node in the hierarchy is a unique Organization . The hierarchy may be traversed recursively to establish the tree structure through getOrganizationNodes() . To relate these Ids to another OSID, getAncestorOrganizations() and getDescendantOrganizations() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Organization available in the Personnel OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentOrganizations() or getChildOrganizations() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: organization elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessOrganizationHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildOrganizationIds(Id organizationId)	Gets the child Ids of the given organization.
OrganizationList	getChildOrganizations(Id organizationId)	Gets the children of the given organization.
Hierarchy	getOrganizationHierarchy()	Gets the hierarchy associated with this session.
Id	getOrganizationHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getOrganizationNodeIds(Id organizationId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given organization.
OrganizationNode	getOrganizationNodes(Id organizationId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given organization.
IdList	getParentOrganizationIds(Id organizationId)	Gets the parent Ids of the given organization.
OrganizationList	getParentOrganizations(Id organizationId)	Gets the parents of the given organization.
IdList	getRootOrganizationIds()	Gets the root organization Ids in this hierarchy.
OrganizationList	getRootOrganizations()	Gets the root organizations in this organization hierarchy.
boolean	hasChildOrganizations(Id organizationId)	Tests if an organization has any children.
boolean	hasParentOrganizations(Id organizationId)	Tests if the Organization has any parents.
boolean	isAncestorOfOrganization(Id id, Id organizationId)	Tests if an Id is an ancestor of an organization.
boolean	isChildOfOrganization(Id id, Id organizationId)	Tests if an organization is a direct child of another.
boolean	isDescendantOfOrganization(Id id, Id organizationId)	Tests if an Id is a descendant of an organization.
boolean	isParentOfOrganization(Id id, Id organizationId)	Tests if an Id is a direct parent of an organization.
void	useComparativeOrganizationView()	The returns from the organization methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryOrganizationView()	A complete view of the Hierarchy returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getOrganizationHierarchyId

Id getOrganizationHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOrganizationHierarchy

Hierarchy getOrganizationHierarchy()
                            throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessOrganizationHierarchy

boolean canAccessOrganizationHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer traversal operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeOrganizationView

void useComparativeOrganizationView()

The returns from the organization methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryOrganizationView

void usePlenaryOrganizationView()

A complete view of the Hierarchy returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootOrganizationIds

IdList getRootOrganizationIds()
                       throws OperationFailedException,
PermissionDeniedException

Gets the root organization Ids in this hierarchy.

Returns:

the root organization Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootOrganizations

OrganizationList getRootOrganizations()
                               throws OperationFailedException,
PermissionDeniedException

Gets the root organizations in this organization hierarchy.

Returns:

the root organizations

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentOrganizations

boolean hasParentOrganizations(Id organizationId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Organization has any parents.

Parameters:

organizationId - the Id of an organization

Returns:

true if the organization has parents, false otherwise

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfOrganization

boolean isParentOfOrganization(Id id,
 Id organizationId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of an organization.

Parameters:

id - an Id

organizationId - the Id of an organization

Returns:

true if this id is a parent of organizationId , false otherwise

Throws:

NotFoundException - organizationId is not found

NullArgumentException - id or organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentOrganizationIds

IdList getParentOrganizationIds(Id organizationId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given organization.

Parameters:

organizationId - the Id of an organization

Returns:

the parent Ids of the organization

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentOrganizations

OrganizationList getParentOrganizations(Id organizationId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given organization.

Parameters:

organizationId - the Id of an organization

Returns:

the parents of the organization

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfOrganization

boolean isAncestorOfOrganization(Id id,
 Id organizationId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an organization.

Parameters:

id - an Id

organizationId - the Id of an organization

Returns:

true if this id is an ancestor of organizationId , false otherwise

Throws:

NotFoundException - organizationId is not found

NullArgumentException - id or organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildOrganizations

boolean hasChildOrganizations(Id organizationId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an organization has any children.

Parameters:

organizationId - the Id of an organization

Returns:

true if the organizationId has children, false otherwise

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfOrganization

boolean isChildOfOrganization(Id id,
 Id organizationId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an organization is a direct child of another.

Parameters:

id - an Id

organizationId - the Id of an organization

Returns:

true if the id is a child of organizationId , false otherwise

Throws:

NotFoundException - organizationId is not found

NullArgumentException - id or organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildOrganizationIds

IdList getChildOrganizationIds(Id organizationId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given organization.

Parameters:

organizationId - the Id to query

Returns:

the children of the organization

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildOrganizations

OrganizationList getChildOrganizations(Id organizationId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given organization.

Parameters:

organizationId - the Id to query

Returns:

the children of the organization

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfOrganization

boolean isDescendantOfOrganization(Id id,
 Id organizationId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an organization.

Parameters:

id - an Id

organizationId - the Id of an organization

Returns:

true if the id is a descendant of the organizationId , false otherwise

Throws:

NotFoundException - organizationId is not found

NullArgumentException - id or organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getOrganizationNodeIds

Node getOrganizationNodeIds(Id organizationId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given organization.

Parameters:

organizationId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

an organization node

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrganizationNodes

OrganizationNode getOrganizationNodes(Id organizationId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given organization.

Parameters:

organizationId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

an organization node

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.