OSID - osid.hierarchy.HierarchySearch Service Interface Definition

Interface	osid.hierarchy.HierarchySearch
Implements	`osid.OsidSearch`
Used By	`osid.hierarchy.HierarchySearchSession`
Description	`HierarchySearch` defines the interface for specifying hierarchy search options.
Method	searchAmongHierarchies
Description	Execute this search using a given list of hierarchies.
Parameters	`osid.id.IdList`	`hierarchyIds`	list of hierarchies
Errors	NULL_ARGUMENT		`hierarchyIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderHierarchyResults
Description	Specify an ordering to the search results.
Parameters	`osid.hierarchy.HierarchySearchOrder`	`hierarchySearchOrder`	hierarchy search order
Errors	NULL_ARGUMENT		`hierarchySearchOrder` is `null`
Errors	UNSUPPORTED		`hierarchySearchOrder` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchySearchRecord
Description	Gets the hierarchy search 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.HierarchySearchRecord`		the hierarchy search record
Errors	NULL_ARGUMENT		`hierarchySearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(hierarchyRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.