OSID - osid.authorization.QualifierHierarchySession Service Interface Definition

Interface	osid.authorization.QualifierHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Qualifier` objects. Each node in the hierarchy is a unique `Qualifier.` The hierarchy may be traversed recursively to establish the tree structure through `getParentQualifiers()` and `getChildQualifiers().` To relate these `Ids` to another OSID, `getQualifierNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Qualifier` available in the Authorization 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 `getParentQualifiers()` or `getChildQualifiers()` 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: qualifier elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getQualifierHierarchyId
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	getQualifierHierarchy
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	canAccessQualifierHierarchy
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	useComparativeQualifierView
Description	The returns from the qualifier 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	usePlenaryQualifierView
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	getRootQualifierIds
Description	Gets the root qualifier `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root qualifier `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootQualifiers
Description	Gets the root qualifiers in this qualifier hierarchy.
Return	`osid.authorization.QualifierList`		the root qualifiers
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentQualifiers
Description	Tests if the `Qualifier` has any parents.
Parameters	`osid.id.Id`	`qualifierId`	a qualifier `Id`
Return	`boolean`		`true` if the qualifier has parents, `false` otherwise
Errors	NOT_FOUND		`qualifierId` is not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfQualifier
Description	Tests if an `Id` is a direct parent of qualifier.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of a qualifier
Return	`boolean`		`true` if this `id` is a parent of `qualifierId,` `false` otherwise
Errors	NOT_FOUND		`qualifierId` is not found
	NULL_ARGUMENT		`id` or `qualifierId` 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	getParentQualifierIds
Description	Gets the parent `Ids` of the given qualifier.
Parameters	`osid.id.Id`	`qualifierId`	a qualifier `Id`
Return	`osid.id.IdList`		the parent `Ids` of the qualifier
Errors	NOT_FOUND		`qualifierId` is not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentQualifiers
Description	Gets the parents of the given qualifier.
Parameters	`osid.id.Id`	`qualifierId`	a qualifier `Id`
Return	`osid.authorization.QualifierList`		the parents of the qualifier
Errors	NOT_FOUND		`qualifierId` is not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfQualifier
Description	Tests if an `Id` is an ancestor of a qualifier.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of a qualifier
Return	`boolean`		`true` if this `id` is an ancestor of `qualifierId,` `false` otherwise
Errors	NOT_FOUND		`qualifierId` not found
	NULL_ARGUMENT		`qualifierId` 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	hasChildQualifiers
Description	Tests if a qualifier has any children.
Parameters	`osid.id.Id`	`qualifierId`	a qualifier `Id`
Return	`boolean`		`true` if the `qualifierId` has children, `false` otherwise
Errors	NOT_FOUND		`qualifierId` not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfQualifier
Description	Tests if a node is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of a qualifier
Return	`boolean`		`true` if the `id` is a child of `qualifierId,` `false` otherwise
Errors	NOT_FOUND		`qualifierId` not found
	NULL_ARGUMENT		`qualifierId` 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	getChildQualifierIds
Description	Gets the child `Ids` of the given qualifier.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` to query
Return	`osid.id.IdList`		the children of the qualifier
Errors	NOT_FOUND		`qualifierId` is not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildQualifiers
Description	Gets the children of the given qualifier.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` to query
Return	`osid.authorization.QualifierList`		the children of the qualifier
Errors	NOT_FOUND		`qualifierId` is not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfQualifier
Description	Tests if an `Id` is a descendant of a qualifier.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of a qualifier
Return	`boolean`		`true` if the `id` is a descendant of the `qualifierId,` `false` otherwise
Errors	NOT_FOUND		`qualifierId` not found
	NULL_ARGUMENT		`qualifierId` 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` is not found return `false.`
Method	getQualifierNodeIds
Description	Gets a portion of the hierarchy for the given qualifier.
Parameters	`osid.id.Id`	`qualifierId`	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 qualifier node
Errors	NOT_FOUND		`functionId` is not found
	NULL_ARGUMENT		`functionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierNodes
Description	Gets a portion of the hierarchy for the given qualifier.
Parameters	`osid.id.Id`	`qualifierId`	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.authorization.QualifierNode`		a qualifier node
Errors	NOT_FOUND		`functionId` is not found
	NULL_ARGUMENT		`functionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.