OSID - osid.hierarchy.HierarchyQuerySession Service Interface Definition

Interface	osid.hierarchy.HierarchyQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.hierarchy.HierarchySearchSession`
Used By	`osid.hierarchy.HierarchyManager`
Used By	`osid.hierarchy.HierarchyProxyManager`
Description	This session provides methods for searching among `Hierarchies`. The search query is constructed using the `HierarchyQuery`. Hierarchies may have a query record indicated by their respective record types. The query record is accessed via the `HierarchuQuery`.
Method	canSearchHierarchies
Description	Tests if this user can perform `Hierarchy` searches. 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 search operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchyQuery
Description	Gets a hierarchy query.
Return	`osid.hierarchy.HierarchyQuery`		the hierarchy query
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchiesByQuery
Description	Gets a list of `Hierarchy` objects matching the given hierarchy query.
Parameters	`osid.hierarchy.HierarchyQuery`	`hierarchyQuery`	the hierarchy query
Return	`osid.hierarchy.HierarchyList`		the returned `HierarchyList`
Errors	NULL_ARGUMENT		`hierarchyQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`hierarchyQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.