OSID - osid.recognition.AcademyHierarchySession Service Interface Definition

Interface	osid.recognition.AcademyHierarchySession
Implements	`osid.OsidSession`
Description	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	getAcademyHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAcademyHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessAcademyHierarchy
Description	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.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAcademyView
Description	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.
Method	usePlenaryAcademyView
Description	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.
Method	getRootAcademyIds
Description	Gets the root academy `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root academy `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootAcademies
Description	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.
Return	`osid.recognition.AcademyList`		the root academies
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentAcademies
Description	Tests if the `Academy` has any parents.
Parameters	`osid.id.Id`	`academyId`	an academy `Id`
Return	`boolean`		`true` if the academy has parents, f `alse` otherwise
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfAcademy
Description	Tests if an `Id` is a direct parent of academy.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`academyId`	the `Id` of an academy
Return	`boolean`		`true` if this `id` is a parent of `academyId,` f `alse` otherwise
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`id` or `academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentAcademyIds
Description	Gets the parent `Ids` of the given academy.
Parameters	`osid.id.Id`	`academyId`	an academy `Id`
Return	`osid.id.IdList`		the parent `Ids` of the academy
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentAcademies
Description	Gets the parent academies of the given `id.`
Parameters	`osid.id.Id`	`academyId`	the `Id` of the `Academy` to query
Return	`osid.recognition.AcademyList`		the parent academies of the `id`
Errors	NOT_FOUND		an `Academy` identified by `Id is` not found
	NULL_ARGUMENT		`academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfAcademy
Description	Tests if an `Id` is an ancestor of an academy.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`academyId`	the `Id` of an academy
Return	`boolean`		`tru` e if this `id` is an ancestor of `academyId,` `false` otherwise
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`id` or `academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	hasChildAcademies
Description	Tests if an academy has any children.
Parameters	`osid.id.Id`	`academyId`	an academy `Id`
Return	`boolean`		`true` if the `academyId` has children, `false` otherwise
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfAcademy
Description	Tests if an academy is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`academyId`	the `Id` of an academy
Return	`boolean`		`true` if the `id` is a child of `academyId,` `false` otherwise
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`id` or `academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildAcademyIds
Description	Gets the child `Ids` of the given academy.
Parameters	`osid.id.Id`	`academyId`	the `Id` to query
Return	`osid.id.IdList`		the children of the academy
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildAcademies
Description	Gets the child academies of the given `id.`
Parameters	`osid.id.Id`	`academyId`	the `Id` of the `Academy` to query
Return	`osid.recognition.AcademyList`		the child academies of the `id`
Errors	NOT_FOUND		an `Academy` identified by `Id is` not found
	NULL_ARGUMENT		`academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfAcademy
Description	Tests if an `Id` is a descendant of an academy.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`academyId`	the `Id` of an academy
Return	`boolean`		`true` if the `id` is a descendant of the `academyId,` `false` otherwise
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`id` or `academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	getAcademyNodeIds
Description	Gets a portion of the hierarchy for the given academy.
Parameters	`osid.id.Id`	`academyId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		an academy node
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAcademyNodes
Description	Gets a portion of the hierarchy for the given academy.
Parameters	`osid.id.Id`	`academyId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.recognition.AcademyNode`		an academy node
Errors	NOT_FOUND		`academyId` is not found
	NULL_ARGUMENT		`academyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.