Interface AcademyHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AcademyHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Academy objects. Each node in the hierarchy is a unique Academy . The hierarchy may be traversed recursively to establish the tree structure through getParentAcademies() and getChildAcademies() . To relate these Ids to another OSID, getAcademyNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Academy available in the Conferral 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 getParentAcademies() or getChildAcademies() 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: academy 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	canAccessAcademyHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getAcademyHierarchy()	Gets the hierarchy associated with this session.
Id	getAcademyHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getAcademyNodeIds(Id academyId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given academy.
AcademyNode	getAcademyNodes(Id academyId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given academy.
AcademyList	getChildAcademies(Id academyId)	Gets the child academies of the given id .
IdList	getChildAcademyIds(Id academyId)	Gets the child Ids of the given academy.
AcademyList	getParentAcademies(Id academyId)	Gets the parent academies of the given id .
IdList	getParentAcademyIds(Id academyId)	Gets the parent Ids of the given academy.
AcademyList	getRootAcademies()	Gets the root academies in the academy hierarchy.
IdList	getRootAcademyIds()	Gets the root academy Ids in this hierarchy.
boolean	hasChildAcademies(Id academyId)	Tests if an academy has any children.
boolean	hasParentAcademies(Id academyId)	Tests if the Academy has any parents.
boolean	isAncestorOfAcademy(Id id, Id academyId)	Tests if an Id is an ancestor of an academy.
boolean	isChildOfAcademy(Id id, Id academyId)	Tests if an academy is a direct child of another.
boolean	isDescendantOfAcademy(Id id, Id academyId)	Tests if an Id is a descendant of an academy.
boolean	isParentOfAcademy(Id id, Id academyId)	Tests if an Id is a direct parent of academy.
void	useComparativeAcademyView()	The returns from the academy methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryAcademyView()	A complete view of the Academy 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

getAcademyHierarchyId

Id getAcademyHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAcademyHierarchy

Hierarchy getAcademyHierarchy()
                       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.

canAccessAcademyHierarchy

boolean canAccessAcademyHierarchy()

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 lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAcademyView

void useComparativeAcademyView()

The returns from the academy 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.

usePlenaryAcademyView

void usePlenaryAcademyView()

A complete view of the Academy 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.

getRootAcademyIds

IdList getRootAcademyIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root academy Ids in this hierarchy.

Returns:

the root academy Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootAcademies

AcademyList getRootAcademies()
                      throws OperationFailedException,
PermissionDeniedException

Gets the root academies in the academy hierarchy. A node with no parents is an orphan. While all academy Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root academies

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentAcademies

boolean hasParentAcademies(Id academyId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Academy has any parents.

Parameters:

academyId - an academy Id

Returns:

true if the academy has parents, f alse otherwise

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfAcademy

boolean isParentOfAcademy(Id id,
 Id academyId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of academy.

Parameters:

id - an Id

academyId - the Id of an academy

Returns:

true if this id is a parent of academyId , f alse otherwise

Throws:

NotFoundException - academyId is not found

NullArgumentException - id or academyId 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} .

getParentAcademyIds

IdList getParentAcademyIds(Id academyId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given academy.

Parameters:

academyId - an academy Id

Returns:

the parent Ids of the academy

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentAcademies

AcademyList getParentAcademies(Id academyId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent academies of the given id .

Parameters:

academyId - the Id of the Academy to query

Returns:

the parent academies of the id

Throws:

NotFoundException - an Academy identified by Id is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfAcademy

boolean isAncestorOfAcademy(Id id,
 Id academyId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an academy.

Parameters:

id - an Id

academyId - the Id of an academy

Returns:

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

Throws:

NotFoundException - academyId is not found

NullArgumentException - id or academyId 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} .

hasChildAcademies

boolean hasChildAcademies(Id academyId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an academy has any children.

Parameters:

academyId - an academy Id

Returns:

true if the academyId has children, false otherwise

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfAcademy

boolean isChildOfAcademy(Id id,
 Id academyId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an academy is a direct child of another.

Parameters:

id - an Id

academyId - the Id of an academy

Returns:

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

Throws:

NotFoundException - academyId is not found

NullArgumentException - id or academyId 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} .

getChildAcademyIds

IdList getChildAcademyIds(Id academyId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given academy.

Parameters:

academyId - the Id to query

Returns:

the children of the academy

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildAcademies

AcademyList getChildAcademies(Id academyId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child academies of the given id .

Parameters:

academyId - the Id of the Academy to query

Returns:

the child academies of the id

Throws:

NotFoundException - an Academy identified by Id is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfAcademy

boolean isDescendantOfAcademy(Id id,
 Id academyId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an academy.

Parameters:

id - an Id

academyId - the Id of an academy

Returns:

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

Throws:

NotFoundException - academyId is not found

NullArgumentException - id or academyId 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} .

getAcademyNodeIds

Node getAcademyNodeIds(Id academyId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given academy.

Parameters:

academyId - 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 academy node

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAcademyNodes

AcademyNode getAcademyNodes(Id academyId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given academy.

Parameters:

academyId - 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 academy node

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.