OSID - osid.course.TermHierarchySession Service Interface Definition

Interface	osid.course.TermHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Term` objects. Each term in the hierarchy is a unique `Term.` The hierarchy may be traversed recursively to establish the tree structure through `getParentTerms()` and `getChildTerms().` To relate these `Ids` to another OSID, `getTermNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Term` available in the Course 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 `getParentTerms()` or `getChildTerms()` 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: term elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getTermHierarchyId
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	getTermHierarchy
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	canAccessTermHierarchy
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	useComparativeTermView
Description	The returns from the term 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	usePlenaryTermView
Description	A complete view of the `Terms` 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	getRootTermIds
Description	Gets the root term `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root term `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootTerms
Description	Gets the root terms in the term hierarchy. A node with no parents is an orphan. While all term `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.course.TermList`		the root terms
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentTerms
Description	Tests if the `Term` has any parents.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Return	`boolean`		`true` if the term has parents, `false` otherwise
Errors	NOT_FOUND		`termId` is not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfTerm
Description	Tests if an `Id` is a direct parent of term.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`termId`	the `Id` of a term
Return	`boolean`		`true` if this `id` is a parent of `termId,` `false` otherwise
Errors	NOT_FOUND		`termId` is not found
	NULL_ARGUMENT		`id` or `termId` 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	getParentTermIds
Description	Gets the parent `Ids` of the given term.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Return	`osid.id.IdList`		the parent `Ids` of the term
Errors	NOT_FOUND		`termId` is not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentTerms
Description	Gets the parents of the given term.
Parameters	`osid.id.Id`	`termId`	the `Id` to query
Return	`osid.course.TermList`		the parents of the term
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfTerm
Description	Tests if an `Id` is an ancestor of a term.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`termId`	the `Id` of a term
Return	`boolean`		`true` if this `id` is an ancestor of `termId,` `false` otherwise
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`id` or `termId` 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	hasChildTerms
Description	Tests if a term has any children.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Return	`boolean`		`true` if the `termId` has children, `false` otherwise
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfTerm
Description	Tests if a node is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`termId`	the `Id` of a term
Return	`boolean`		`true` if the `id` is a child of `termId,` `false` otherwise
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` 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	getChildTermIds
Description	Gets the child `Ids` of the given term.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Return	`osid.id.IdList`		the child `Ids` of the term
Errors	NOT_FOUND		`termId` is not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildTerms
Description	Gets the children of the given term.
Parameters	`osid.id.Id`	`termId`	the `Id` to query
Return	`osid.course.TermList`		the children of the term
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfTerm
Description	Tests if an `Id` is a descendant of a term.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`termId`	the `Id` of a term
Return	`boolean`		`true` if the `id` is a descendant of the `termId,` `false` otherwise
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` or `id` 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	getTermNodeIds
Description	Gets a portion of the hierarchy for the given term.
Parameters	`osid.id.Id`	`termId`	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`		a term node
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTermNodes
Description	Gets a portion of the hierarchy for the given term.
Parameters	`osid.id.Id`	`termId`	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.course.TermNode`		a term node
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.