OSID - osid.inquiry.InquestHierarchySession Service Interface Definition

Interface	osid.inquiry.InquestHierarchySession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.InquiryManager`
Used By	`osid.inquiry.InquiryProxyManager`
Description	This session defines methods for traversing a hierarchy of `Inquests`. Each node in the hierarchy is a unique `Inquest`. The hierarchy may be traversed recursively to establish the tree structure through `getParentInquests()` and `getChildInquests()`. To relate these `Ids` to another OSID, `getInquestNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Inquest` available in the Control OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root inquest or a child of another inquest. 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 `getParentInquests()` or `getChildInquests()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized inquiryways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative inquest view: inquest elements may be silently omitted or re-ordered plenary inquest view: provides a complete set or is an error condition
Method	getInquestHierarchyId
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	getInquestHierarchy
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	canAccessInquestHierarchy
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	useComparativeInquestView
Description	The returns from the inquest 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	usePlenaryInquestView
Description	A complete view of the `Inquests` 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	getRootInquestIds
Description	Gets the root inquest `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root inquest `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootInquests
Description	Gets the root inquest in the inquest hierarchy. an inquest with no parents is an orphan. While all inquest `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root inquest or child of another inquest.
Return	`osid.inquiry.InquestList`		the root inquests
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentInquests
Description	Tests if the `Inquest` has any parents.
Parameters	`osid.id.Id`	`inquestId`	an inquest `Id`
Return	`boolean`		`true` if the inquest has parents, f `alse` otherwise
Errors	NOT_FOUND		`inquestId` is not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfInquest
Description	Tests if an `Id` is a direct parent of inquest.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`inquestId`	the `Id` of an inquest
Return	`boolean`		`true` if this `id` is a parent of `inquestId`, f `alse` otherwise
Errors	NOT_FOUND		`inquestId` is not found
	NULL_ARGUMENT		`id` or `inquestId` 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	getParentInquestIds
Description	Gets the parent `Ids` of the given inquest.
Parameters	`osid.id.Id`	`inquestId`	an inquest `Id`
Return	`osid.id.IdList`		the parent `Ids` of the inquest
Errors	NOT_FOUND		`inquestId` is not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentInquests
Description	Gets the parents of the given inquest.
Parameters	`osid.id.Id`	`inquestId`	the `Id` to query
Return	`osid.inquiry.InquestList`		the parents of the inquest
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfInquest
Description	Tests if an `Id` is an ancestor of an inquest.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`inquestId`	the `Id` of an inquest
Return	`boolean`		`true` if this `id` is an ancestor of `inquestId`, `false` otherwise
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` 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` not found return `false`.
Method	hasChildInquests
Description	Tests if an inquest has any children.
Parameters	`osid.id.Id`	`inquestId`	an inquest `Id`
Return	`boolean`		`true` if the `inquestId` has children, `false` otherwise
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfInquest
Description	Tests if an inquest is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`inquestId`	the `Id` of an inquest
Return	`boolean`		`true` if the `id` is a child of `inquestId`, `false` otherwise
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`id` or `inquestId` 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	getChildInquestIds
Description	Gets the child `Ids` of the given inquest.
Parameters	`osid.id.Id`	`inquestId`	the `Id` to query
Return	`osid.id.IdList`		the children of the inquest
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildInquests
Description	Gets the children of the given inquest.
Parameters	`osid.id.Id`	`inquestId`	the `Id` to query
Return	`osid.inquiry.InquestList`		the children of the inquest
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfInquest
Description	Tests if an `Id` is a descendant of an inquest.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`inquestId`	the `Id` of an inquest
Return	`boolean`		`true` if the `id` is a descendant of the `inquestId`, `false` otherwise
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`id` or `inquestId` 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	getInquestNodeIds
Description	Gets a portion of the hierarchy for the given inquest.
Parameters	`osid.id.Id`	`inquestId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the inquest.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the inquest.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given inquest, `false` to omit the siblings
Return	`osid.hierarchy.Node`		an inquest node
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInquestNodes
Description	Gets a portion of the hierarchy for the given inquest.
Parameters	`osid.id.Id`	`inquestId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the hierarchy.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the hierarchy.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given inquest, `false` to omit the siblings
Return	`osid.inquiry.InquestNode`		an inquest node
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.