OSID - osid.hierarchy.HierarchyLookupSession Service Interface Definition

Interface	osid.hierarchy.HierarchyLookupSession
Implements	`osid.OsidSession`
Used By	`osid.hierarchy.HierarchyManager`
Used By	`osid.hierarchy.HierarchyProxyManager`
Description	This session provides methods for retrieving `Hierarchies`. The `Hierarchy` represents a structure of OSID `Ids`. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the `Hierarchies` objects it can access, without breaking execution. However, an assessment may only be useful if all `Hierarchy` objects referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.
Method	canLookupHierarchies
Description	Tests if this user can perform `Hierarchy` lookups. 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 to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeHierarchyView
Description	The returns from the lookup 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	usePlenaryHierarchyView
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	getHierarchy
Description	Gets the `Hierarchy` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Hierarchy` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Hierarchy` and retained for compatibility.
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the `Hierarchy` to retrieve
Return	`osid.hierarchy.Hierarchy`		the returned `Hierarchy`
Errors	NOT_FOUND		no `Hierarchy` found with the given `Id`
	NULL_ARGUMENT		`hierarchyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchiesByIds
Description	Gets a `Hierarchy` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the hierarchies specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Hierarchy` objects may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`hierarchyIds`	the list of `Ids` to retrieve
Return	`osid.hierarchy.HierarchyList`		the returned `Hierarchy` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`hierarchyIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchiesByGenusType
Description	Gets a `HierarchyList` corresponding to the given genus `Type` which does not include hierarchies of types derived from the specified `Type`. In plenary mode, the returned list contains all known hierarchies or an error results. Otherwise, the returned list may contain only those hierarchies that are accessible through this session.
Parameters	`osid.type.Type`	`hierarchyGenusType`	a hierarchy genus type
Return	`osid.hierarchy.HierarchyList`		the returned `Hierarchy` list
Errors	NULL_ARGUMENT		`hierarchyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchiesByParentGenusType
Description	Gets a `HierarchyList` corresponding to the given hierarchy genus `Type` and include any additional hierarchies with types derived from the specified `Type`.In plenary mode, the returned list contains all known hierarchies or an error results. Otherwise, the returned list may contain only those hierarchies that are accessible through this session.
Parameters	`osid.type.Type`	`hierarchyGenusType`	a hierarchy genus type
Return	`osid.hierarchy.HierarchyList`		the returned `Hierarchy` list
Errors	NULL_ARGUMENT		`hierarchyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchiesByRecordType
Description	Gets a `HierarchyList` corresponding to the given hierarchy record `Type`. The set of hierarchies implementing the given record type are returned. In plenary mode, the returned list contains all known hierarchies or an error results. Otherwise, the returned list may contain only those hierarchies that are accessible through this session.
Parameters	`osid.type.Type`	`hierarchyRecordType`	a hierarchy record type
Return	`osid.hierarchy.HierarchyList`		the returned `Hierarchy` list
Errors	NULL_ARGUMENT		`hierarchyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchiesByProvider
Description	Gets a `HierarchyList` for the given provider. The set of hierarchies implementing the given record type are returned. In plenary mode, the returned list contains all known hierarchies or an error results. Otherwise, the returned list may contain only those hierarchies that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.hierarchy.HierarchyList`		the returned `Hierarchy` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchies
Description	Gets all hierarchies. In plenary mode, the returned list contains all known hierarchies or an error results. Otherwise, the returned list may contain only those hierarchies that are accessible through this session.
Return	`osid.hierarchy.HierarchyList`		a list of `Hierarchies`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.