OSID - osid.offering.ResultSearchSession Service Interface Definition

Interface	osid.offering.ResultSearchSession
Implements	`osid.offering.ResultQuerySession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session provides methods for searching `Results`. The search query is constructed using the `ResultQuery`. The result record `Type` also specifies the record for the result query. `getResultsByQuery()` is the basic search method and returns a list of `Result` elements. A more advanced search may be performed with `getResultsBySearch()`. It accepts a `ResultSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getResultsBySearch()` returns a `ResultSearchResults` that can be used to access the resulting `ResultList` or be used to perform a search within the result set through `ResultSearch`. This session defines views that offer differing behaviors for searching. federated catalogue view: searches include results in catalogues of which this catalogue is an ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to results in this catalogue Results may have a query record indicated by their respective record types. The query record is accessed via the `ResultQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getResultSearch
Description	Gets a result search.
Return	`osid.offering.ResultSearch`		the result search
Compliance	`mandatory`		This method must be implemented.
Method	getResultSearchOrder
Description	Gets a result search order. The `ResultSearchOrder` is supplied to a `ResultSearch` to specify the ordering of results.
Return	`osid.offering.ResultSearchOrder`		the result search order
Compliance	`mandatory`		This method must be implemented.
Method	getResultsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.offering.ResultQuery`	`resultQuery`	the result query
Parameters	`osid.offering.ResultSearch`	`resultSearch`	the result search
Return	`osid.offering.ResultSearchResults`		the search results
Errors	NULL_ARGUMENT		`resultQuery` or `resultSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resultQuery` or `resultSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getResultQueryFromInspector
Description	Gets a result query from an inspector. The inspector is available from a `ResultSearchResults`.
Parameters	`osid.offering.ResultQueryInspector`	`resultQueryInspector`	a result query inspector
Return	`osid.offering.ResultQuery`		the result query
Errors	NULL_ARGUMENT		`resultQueryInspector` is `null`
Errors	UNSUPPORTED		`resultQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.