OSID - osid.hierarchy.HierarchySearchResults Service Interface Definition

Interface	osid.hierarchy.HierarchySearchResults
Implements	`osid.OsidSearchResults`
Description	This interface provides a means to capture results of a search.
Method	getHierarchies
Description	Gets the hierarchy list resulting from the search.
Return	`osid.hierarchy.HierarchyList`		the hierarchy list
Errors	ILLEGAL_STATE		the hierarchy list was already retrieved
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchyQueryInspector
Description	Gets the inspector for the query to examine the terms used in the search.
Return	`osid.hierarchy.HierarchyQueryInspector`		the hierarchy query inspector
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchySearchResultsRecord
Description	Gets the hierarchy search results record corresponding to the given hierarchy search record `Type.` This method is used to retrieve an object implementing the requested record.
Parameters	`osid.type.Type`	`hierarchySearchRecordType`	a hierarchy search record type
Return	`osid.hierarchy.records.HierarchySearchResultsRecord`		the hierarchy search results record
Errors	NULL_ARGUMENT		`hierarchySearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(hierarchySearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.