OSID - osid.grading.GradebookHierarchySession Service Interface Definition

Interface	osid.grading.GradebookHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Gradebook` objects. Each node in the hierarchy is a unique `Gradebook.` The hierarchy may be traversed recursively to establish the tree structure through `getParentGradebooks()` and `getChildGradebooks().` To relate these `Ids` to another OSID, `getGradebookNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Gradebook` available in the Gradebooking 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 `getParentGradebooks()` or `getChildGradebooks()` 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: gradebook elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getGradebookHierarchyId
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	getGradebookHierarchy
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	canAccessGradebookHierarchy
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 an application that may not offer hierrachy traversal operations to unauthorized users.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeGradebookView
Description	The returns from the gradebook 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	usePlenaryGradebookView
Description	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.
Method	getRootGradebookIds
Description	Gets the root gradebook `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root gradebook `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootGradebooks
Description	Gets the root gradebooks in this gradebook hierarchy.
Return	`osid.grading.GradebookList`		the root gradebooks
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentGradebooks
Description	Tests if the `Gradebook` has any parents.
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of a gradebook
Return	`boolean`		`true` if the gradebook has parents, `false` otherwise
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfGradebook
Description	Tests if an `Id` is a direct parent of a gradebook.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of a gradebook
Return	`boolean`		`true` if this `id` is a parent of `gradebookId,` `false` otherwise
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`id` or `gradebookId` 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	getParentGradebookIds
Description	Gets the parent `Ids` of the given gradebook.
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of a gradebook
Return	`osid.id.IdList`		the parent `Ids` of the gradebook
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentGradebooks
Description	Gets the parents of the given gradebook.
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of a gradebook
Return	`osid.grading.GradebookList`		the parents of the gradebook
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfGradebook
Description	Tests if an `Id` is an ancestor of a gradebook.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of a gradebook
Return	`boolean`		`true` if this `id` is an ancestor of `gradebookId,` `false` otherwise
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`id` or `gradebookId` 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	hasChildGradebooks
Description	Tests if a gradebook has any children.
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of a gradebook
Return	`boolean`		`true` if the `gradebookId` has children, `false` otherwise
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfGradebook
Description	Tests if a gradebook is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of a gradebook
Return	`boolean`		`true` if the `id` is a child of `gradebookId,` `false` otherwise
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`id` or `gradebookId` 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	getChildGradebookIds
Description	Gets the child `Ids` of the given gradebook.
Parameters	`osid.id.Id`	`gradebookId`	the `Id` to query
Return	`osid.id.IdList`		the children of the gradebook
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildGradebooks
Description	Gets the children of the given gradebook.
Parameters	`osid.id.Id`	`gradebookId`	the `Id` to query
Return	`osid.grading.GradebookList`		the children of the gradebook
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfGradebook
Description	Tests if an `Id` is a descendant of a gradebook.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of a gradebook
Return	`boolean`		`true` if the `id` is a descendant of the `gradebookId,` `false` otherwise
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`id` or `gradebookId` 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	getGradebookNodeIds
Description	Gets a portion of the hierarchy for the given gradebook.
Parameters	`osid.id.Id`	`gradebookId`	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 gradebook node
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookNodes
Description	Gets a portion of the hierarchy for the given gradebook.
Parameters	`osid.id.Id`	`gradebookId`	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.grading.GradebookNode`		a gradebook node
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.