OSID - osid.hold.OublietteHierarchySession Service Interface Definition

Interface	osid.hold.OublietteHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Oubliette` objects. Each node in the hierarchy is a unique `Oubliette.` The hierarchy may be traversed recursively to establish the tree structure through `getParentOubliette()` and `getChildOubliettes().` To relate these `Ids` to another OSID, `getOublietteNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Oubliette` available in the Hold OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root issue or a child of another issue. 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 `getParentOubliettes()` or `getChildOubliettes()` 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 oubliette view: oubliette elements may be silently omitted or re-ordered plenary oubliette view: provides a complete set or is an error condition
Method	getOublietteHierarchyId
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	getOublietteHierarchy
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	canAccessOublietteHierarchy
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	useComparativeOublietteView
Description	The returns from the oubliette 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	usePlenaryOublietteView
Description	s
Compliance	`mandatory`		This method is must be implemented.
Method	getRootOublietteIds
Description	Gets the root oubliette `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root oubliette `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootOubliettes
Description	Gets the root oubliette in the oubliette hierarchy. A issue with no parents is an orphan. While all oubliette `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root issue or child of another issue.
Return	`osid.hold.OublietteList`		the root oubliettes
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentOubliettes
Description	Tests if the `Oubliette` has any parents.
Parameters	`osid.id.Id`	`oublietteId`	an oubliette `Id`
Return	`boolean`		`true` if the oubliette has parents, f `alse` otherwise
Errors	NOT_FOUND		`oublietteId` is not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfOubliette
Description	Tests if an `Id` is a direct parent of oubliette.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of an oubliette
Return	`boolean`		`true` if this `id` is a parent of `oublietteId,` f `alse` otherwise
Errors	NOT_FOUND		`oublietteId` is not found
	NULL_ARGUMENT		`id` or `oublietteId` 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	getParentOublietteIds
Description	Gets the parent `Ids` of the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	an oubliette `Id`
Return	`osid.id.IdList`		the parent `Ids` of the oubliette
Errors	NOT_FOUND		`oublietteId` is not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentOubliettes
Description	Gets the parents of the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` to query
Return	`osid.hold.OublietteList`		the parents of the oubliette
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfOubliette
Description	Tests if an `Id` is an ancestor of an oubliette.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of an oubliette
Return	`boolean`		`tru` e if this `id` is an ancestor of `oublietteId,` `false` otherwise
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` 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	hasChildOubliettes
Description	Tests if an oubliette has any children.
Parameters	`osid.id.Id`	`oublietteId`	an oubliette `Id`
Return	`boolean`		`true` if the `oublietteId` has children, `false` otherwise
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfOubliette
Description	Tests if an oubliette is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of an oubliette
Return	`boolean`		`true` if the `id` is a child of `oublietteId,` `false` otherwise
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`id` or `oublietteId` 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	getChildOublietteIds
Description	Gets the child `Ids` of the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` to query
Return	`osid.id.IdList`		the children of the oubliette
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildOubliettes
Description	Gets the children of the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` to query
Return	`osid.hold.OublietteList`		the children of the oubliette
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfOubliette
Description	Tests if an `Id` is a descendant of an oubliette.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of an oubliette
Return	`boolean`		`true` if the `id` is a descendant of the `oublietteId,` `false` otherwise
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`id` or `oublietteId` 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	getOublietteNodeIds
Description	Gets a portion of the hierarchy for the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the issue.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the issue.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given issue, `false` to omit the siblings
Return	`osid.hierarchy.Node`		an oubliette node
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteNodes
Description	Gets a portion of the hierarchy for the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the issue.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the issue.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given issue, `false` to omit the siblings
Return	`osid.hold.OublietteNode`		an oubliette node
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.