OSID - osid.resource.BinHierarchySession Service Interface Definition

Interface	osid.resource.BinHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Bin` objects. Each node in the hierarchy is a unique `Bin.` The hierarchy may be traversed recursively to establish the tree structure through `getParentBins()` and `getChildBins().` To relate these `Ids` to another OSID, `getBinNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Bin` available in the Resource 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 `getParentBins()` or `getChildBins()` 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: bin elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getBinHierarchyId
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	getBinHierarchy
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	canAccessBinHierarchy
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 traversal functions to unauthorized users.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBinView
Description	The returns from the bin 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	usePlenaryBinView
Description	A complete view of the `Bin` 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	getRootBinIds
Description	Gets the root bin `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root bin `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootBins
Description	Gets the root bins in the bin hierarchy. A node with no parents is an orphan. While all bin `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.resource.BinList`		the root bins
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentBins
Description	Tests if the `Bin` has any parents.
Parameters	`osid.id.Id`	`binId`	the `Id` of a bin
Return	`boolean`		`true` if the bin has parents, `false` otherwise
Errors	NOT_FOUND		`binId` is not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfBin
Description	Tests if an `Id` is a direct parent of a bin.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`binId`	the `Id` of a bin
Return	`boolean`		`true` if this `id` is a parent of `binId,` `false` otherwise
Errors	NOT_FOUND		`binId` is not found
	NULL_ARGUMENT		`id` or `binId` 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	getParentBinIds
Description	Gets the parent `Ids` of the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of a bin
Return	`osid.id.IdList`		the parent `Ids` of the bin
Errors	NOT_FOUND		`binId` is not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentBins
Description	Gets the parents of the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` to query
Return	`osid.resource.BinList`		the parents of the bin
Errors	NOT_FOUND		`binId` not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfBin
Description	Tests if an `Id` is an ancestor of a bin.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`binId`	the `Id` of a bin
Return	`boolean`		`true` if this `id` is an ancestor of `binId,` `false` otherwise
Errors	NOT_FOUND		`binId` is not found
	NULL_ARGUMENT		`id` or `binId` 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	hasChildBins
Description	Tests if a bin has any children.
Parameters	`osid.id.Id`	`binId`	the `Id` of a bin
Return	`boolean`		`true` if the `binId` has children, `false` otherwise
Errors	NOT_FOUND		`binId` not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfBin
Description	Tests if a bin is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`binId`	the `Id` of a bin
Return	`boolean`		`true` if the `id` is a child of `binId,` `false` otherwise
Errors	NOT_FOUND		`binId` is not found
	NULL_ARGUMENT		`id` or `binId` 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	getChildBinIds
Description	Gets the child `Ids` of the given bin .
Parameters	`osid.id.Id`	`binId`	the `Id` to query
Return	`osid.id.IdList`		the children of the bin
Errors	NOT_FOUND		`binId` not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildBins
Description	Gets the children of the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` to query
Return	`osid.resource.BinList`		the children of the bin
Errors	NOT_FOUND		`binId` not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfBin
Description	Tests if an `Id` is a descendant of a bin.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`binId`	the `Id` of a bin
Return	`boolean`		`true` if the `id` is a descendant of the `binId,` `false` otherwise
Errors	NOT_FOUND		`binId` is not found
	NULL_ARGUMENT		`id` or `binId` 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	getBinNodeIds
Description	Gets a portion of the hierarchy for the given bin.
Parameters	`osid.id.Id`	`binId`	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 bin node
Errors	NOT_FOUND		`binId` not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBinNodes
Description	Gets a portion of the hierarchy for the given bin.
Parameters	`osid.id.Id`	`binId`	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.resource.BinNode`		a bin node
Errors	NOT_FOUND		`binId` not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.