OSID - osid.recognition.AwardSearchSession Service Interface Definition

Interface	osid.recognition.AwardSearchSession
Implements	`osid.recognition.AwardQuerySession`
Used By	`osid.recognition.RecognitionManager`
Used By	`osid.recognition.RecognitionProxyManager`
Description	This session provides methods for searching `Awards`. The search query is constructed using the `AwardQuery`. The award record `Type` also specifies the record for the award query. `getAwardsByQuery()` is the basic search method and returns a list of `Award` elements. A more advanced search may be performed with `getAwardsBySearch()`. It accepts an `AwardSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAwardsBySearch()` returns an `AwardSearchResults` that can be used to access the resulting `AwardList` or be used to perform a search within the result set through `AwardSearch`. Awards may have a query record indicated by their respective record types. The query record is accessed via the `AwardQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getAwardSearch
Description	Gets an award search.
Return	`osid.recognition.AwardSearch`		the award search
Compliance	`mandatory`		This method must be implemented.
Method	getAwardSearchOrder
Description	Gets an award search order. The `AwardSearchOrder` is supplied to an `AwardSearch` to specify the ordering of results.
Return	`osid.recognition.AwardSearchOrder`		the award search order
Compliance	`mandatory`		This method must be implemented.
Method	getAwardsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.recognition.AwardQuery`	`awardQuery`	the award query
Parameters	`osid.recognition.AwardSearch`	`awardSearch`	the award search
Return	`osid.recognition.AwardSearchResults`		the award search results
Errors	NULL_ARGUMENT		`awardQuery` or `awardSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`awardQuery` or `awardSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAwardQueryFromInspector
Description	Gets an award query from an inspector. The inspector is available from an `AwardSearchResults`.
Parameters	`osid.recognition.AwardQueryInspector`	`awardQueryInspector`	an award query inspector
Return	`osid.recognition.AwardQuery`		the academy query
Errors	NULL_ARGUMENT		`awardQueryInspector` is `null`
Errors	UNSUPPORTED		`awardQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.