OSID - osid.hold.OublietteSearchSession Service Interface Definition

Interface	osid.hold.OublietteSearchSession
Implements	`osid.hold.OublietteQuerySession`
Description	This session provides methods for searching among `Oubliette` objects. The search query is constructed using the `OublietteQuery.` `getOublietteByQuery()` is the basic search method and returns a list of `Oubliettes.` A more advanced search may be performed with `getOublietteBySearch().` It accepts a `OublietteSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getOublietteBySearch()` returns a `OublietteSearchResults` that can be used to access the resulting `OublietteList` or be used to perform a search within the result set through `OublietteSearch.` Oubliettes may have a query record indicated by their respective record types. The query record is accessed via the `OublietteQuery.`
Method	getOublietteSearch
Description	Gets an oubliette search.
Return	`osid.hold.OublietteSearch`		the oubliette search
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteSearchOrder
Description	Gets an oubliette search order. The `OublietteSearchOrder` is supplied to a `OublietteSearch` to specify the ordering of results.
Return	`osid.hold.OublietteSearchOrder`		the oubliette search order
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hold.OublietteQuery`	`oublietteQuery`	the oubliette query
Parameters	`osid.hold.OublietteSearch`	`oublietteSearch`	the oubliette search
Return	`osid.hold.OublietteSearchResults`		the oubliette search results
Errors	NULL_ARGUMENT		`oublietteQuery` or `oublietteSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`oublietteQuery` or `oublietteSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteQueryFromInspector
Description	Gets an oubliette query from an inspector. The inspector is available from a `OublietteSearchResults.`
Parameters	`osid.hold.OublietteQueryInspector`	`oublietteQueryInspector`	an oubliette query inspector
Return	`osid.hold.OublietteQuery`		the oubliette query
Errors	NULL_ARGUMENT		`oublietteQueryInspector` is `null`
Errors	UNSUPPORTED		`oublietteQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.