OSID - osid.hierarchy.HierarchySearchSession Service Interface Definition

Interface	osid.hierarchy.HierarchySearchSession
Implements	`osid.hierarchy.HierarchyQuerySession`
Description	This session provides methods for searching among `Hierarchy` objects. The search query is constructed using the `HierarchyQuery.` `getHierarchiesByQuery()` is the basic search method and returns a list of `Hierarchy` objects. A more advanced search may be performed with `getHierarchiesBySearch().` It accepts a `HierarchySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getHierarchiesBySearch()` returns a `HierarchySearchResults` that can be used to access the resulting `HierarchyList` or be used to perform a search within the result set through `HierarchySearch.` Hierarchies may have a query record indicated by their respective record types. The query record query is accessed via the `HierarchuQuery.`
Method	getHierarchySearch
Description	Gets a hierarchy search.
Return	`osid.hierarchy.HierarchySearch`		the hierarchy search
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchySearchOrder
Description	Gets a hierarchy search order. The `HierarchySearchOrder` is supplied to a `HierarchySearch` to specify the ordering of results.
Return	`osid.hierarchy.HierarchySearchOrder`		the hierarchy search order
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchiesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hierarchy.HierarchyQuery`	`hierarchyQuery`	the hierarchy query
Parameters	`osid.hierarchy.HierarchySearch`	`hierarchySearch`	the hierarchy search
Return	`osid.hierarchy.HierarchySearchResults`		the hierarchy search results
Errors	NULL_ARGUMENT		`hierarchyQuery` or `hierarchySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`hierarchyQuery` or `hierarchySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchyQueryFromInspector
Description	Gets a hierarchy query from an inspector. The inspector is available from a `HierarchySearchResults.`
Parameters	`osid.hierarchy.HierarchyQueryInspector`	`hierarchyQueryInspector`	a hierarchy query inspector
Return	`osid.hierarchy.HierarchyQuery`		the hierarchy query
Errors	NULL_ARGUMENT		`hierarchyQueryInspector` is `null`
Errors	UNSUPPORTED		`hierarchyQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.