OSID - osid.installation.DepotHierarchySession Service Interface Definition

Interface	osid.installation.DepotHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Depot` objects. Each node in the hierarchy is a unique `Depot.` The hierarchy may be traversed recursively to establish the tree structure through `getParentDepots()` and `getChildDepots().` To relate these `Ids` to another OSID, `getDepotNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Depot` available in the Depoting 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 `getParentDepots()` or `getChildDepots()` 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: depot elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getDepotHierarchyId
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	getDepotHierarchy
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	canAccessDepotHierarchy
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	useComparativeDepotView
Description	The returns from the depot 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	usePlenaryDepotView
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	getRootDepotIds
Description	Gets the root depot `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root depot `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootDepots
Description	Gets the root depots in this depot hierarchy.
Return	`osid.installation.DepotList`		the root depots
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentDepots
Description	Tests if the `Depot` has any parents.
Parameters	`osid.id.Id`	`depotId`	the `Id` of a depot
Return	`boolean`		`true` if the depot has parents, `false` otherwise
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfDepot
Description	Tests if an `Id` is a direct parent of a depot.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`depotId`	the `Id` of a depot
Return	`boolean`		`true` if this `id` is a parent of `depotId,` `false` otherwise
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`id` or `depotId` 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	getParentDepotIds
Description	Gets the parent `Ids` of the given depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` of a depot
Return	`osid.id.IdList`		the parent `Ids` of the depot
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentDepots
Description	Gets the parents of the given depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` of a depot
Return	`osid.installation.DepotList`		the parents of the depot
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfDepot
Description	Tests if an `Id` is an ancestor of a depot.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`depotId`	the `Id` of a depot
Return	`boolean`		`true` if this `id` is an ancestor of `depotId,` `false` otherwise
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`id` or `depotId` 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	hasChildDepots
Description	Tests if a depot has any children.
Parameters	`osid.id.Id`	`depotId`	the `Id` of a depot
Return	`boolean`		`true` if the `depotId` has children, `false` otherwise
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfDepot
Description	Tests if a depot is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`depotId`	the `Id` of a depot
Return	`boolean`		`true` if the `id` is a child of `depotId,` `false` otherwise
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`id` or `depotId` 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	getChildDepotIds
Description	Gets the child `Ids` of the given depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` to query
Return	`osid.id.IdList`		the children of the depot
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildDepots
Description	Gets the children of the given depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` to query
Return	`osid.installation.DepotList`		the children of the depot
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfDepot
Description	Tests if an `Id` is a descendant of a depot.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`depotId`	the `Id` of a depot
Return	`boolean`		`true` if the `id` is a descendant of the `depotId,` `false` otherwise
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`id` or `depotId` 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	getDepotNodeIds
Description	Gets a portion of the hierarchy for the given depot.
Parameters	`osid.id.Id`	`depotId`	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 depot node
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDepotNodes
Description	Gets a portion of the hierarchy for the given depot.
Parameters	`osid.id.Id`	`depotId`	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.installation.DepotNode`		a depot node
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.