OSID - osid.resourcing.FoundryHierarchySession Service Interface Definition

Interface	osid.resourcing.FoundryHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Foundry` objects. Each node in the hierarchy is a unique `Foundry.` The hierarchy may be traversed recursively to establish the tree structure through `getParentFoundries()` and `getChildFoundries().` To relate these `Ids` to another OSID, `getFoundryNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Foundry` available in the Resourcing OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root foundry or a child of another foundry. 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 `getParentFoundries()` or `getChildFoundries()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized effortways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative foundry view: foundry elements may be silently omitted or re-ordered plenary foundry view: provides a complete set or is an error condition
Method	getFoundryHierarchyId
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	getFoundryHierarchy
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	canAccessFoundryHierarchy
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	useComparativeFoundryView
Description	The returns from the foundry 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	usePlenaryFoundryView
Description	A complete view of the `Foundries` 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	getRootFoundryIds
Description	Gets the root foundry `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root foundry `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootFoundries
Description	Gets the root foundry in the foundry hierarchy. A foundry with no parents is an orphan. While all foundry `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root foundry or child of another foundry.
Return	`osid.resourcing.FoundryList`		the root foundries
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentFoundries
Description	Tests if the `Foundry` has any parents.
Parameters	`osid.id.Id`	`foundryId`	a foundry `Id`
Return	`boolean`		`true` if the foundry has parents, f `alse` otherwise
Errors	NOT_FOUND		`foundryId` is not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfFoundry
Description	Tests if an `Id` is a direct parent of foundry.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`foundryId`	the `Id` of a foundry
Return	`boolean`		`true` if this `id` is a parent of `foundryId,` f `alse` otherwise
Errors	NOT_FOUND		`foundryId` is not found
	NULL_ARGUMENT		`id` or `foundryId` 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	getParentFoundryIds
Description	Gets the parent `Ids` of the given foundry.
Parameters	`osid.id.Id`	`foundryId`	a foundry `Id`
Return	`osid.id.IdList`		the parent `Ids` of the foundry
Errors	NOT_FOUND		`foundryId` is not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentFoundries
Description	Gets the parents of the given foundry.
Parameters	`osid.id.Id`	`foundryId`	the `Id` to query
Return	`osid.resourcing.FoundryList`		the parents of the foundry
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfFoundry
Description	Tests if an `Id` is an ancestor of a foundry.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`foundryId`	the `Id` of a foundry
Return	`boolean`		`tru` e if this `id` is an ancestor of `foundryId,` `false` otherwise
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` 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	hasChildFoundries
Description	Tests if a foundry has any children.
Parameters	`osid.id.Id`	`foundryId`	a foundry `Id`
Return	`boolean`		`true` if the `foundryId` has children, `false` otherwise
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfFoundry
Description	Tests if a foundry is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`foundryId`	the `Id` of a foundry
Return	`boolean`		`true` if the `id` is a child of `foundryId,` `false` otherwise
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`id` or `foundryId` 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	getChildFoundryIds
Description	Gets the child `Ids` of the given foundry.
Parameters	`osid.id.Id`	`foundryId`	the `Id` to query
Return	`osid.id.IdList`		the children of the foundry
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildFoundries
Description	Gets the children of the given foundry.
Parameters	`osid.id.Id`	`foundryId`	the `Id` to query
Return	`osid.resourcing.FoundryList`		the children of the foundry
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfFoundry
Description	Tests if an `Id` is a descendant of a foundry.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`foundryId`	the `Id` of a foundry
Return	`boolean`		`true` if the `id` is a descendant of the `foundryId,` `false` otherwise
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`id` or `foundryId` 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	getFoundryNodeIds
Description	Gets a portion of the hierarchy for the given foundry.
Parameters	`osid.id.Id`	`foundryId`	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 hier.archy
	`boolean`	`includeSiblings`	`true` to include the siblings of the given foundry, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a foundry node
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryNodes
Description	Gets a portion of the hierarchy for the given foundry.
Parameters	`osid.id.Id`	`foundryId`	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 foundry, `false` to omit the siblings
Return	`osid.resourcing.FoundryNode`		a foundry node
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.