OSID - osid.rules.check.AgendaSearchSession Service Interface Definition

Interface	osid.rules.check.AgendaSearchSession
Implements	`osid.rules.check.AgendaQuerySession`
Description	This session provides methods for searching among `Agenda` objects. The search query is constructed using the `AgendaQuery.` `getAgendasByQuery()` is the basic search method and returns a list of `Agendas.` A more advanced search may be performed with `getAgendasBySearch().` It accepts an `AgendaSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAgendasBySearch()` returns an `AgendaSearchResults` that can be used to access the resulting `AgendaList` or be used to perform a search within the result set through `AgendaSearch.` This session defines views that offer differing behaviors for searching. federated engine view: searches include agendas in engines of which this engine is an ancestor in the engine hierarchy isolated engine view: searches are restricted to agendas in this engine Agendas may have a query record indicated by their respective record types. The query record is accessed via the `AgendaQuery.`
Method	getAgendaSearch
Description	Gets an agenda search.
Return	`osid.rules.check.AgendaSearch`		the agenda search
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaSearchOrder
Description	Gets an agenda search order. The `AgendaSearchOrder` is supplied to an `AgendaSearch` to specify the ordering of results.
Return	`osid.rules.check.AgendaSearchOrder`		the agenda search order
Compliance	`mandatory`		This method must be implemented.
Method	getAgendasBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.rules.check.AgendaQuery`	`agendaQuery`	the agenda query
Parameters	`osid.rules.check.AgendaSearch`	`agendaSearch`	the agenda search
Return	`osid.rules.check.AgendaSearchResults`		the agenda search results
Errors	NULL_ARGUMENT		`agendaQuery` or `agendaSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agendaQuery` or `agendaSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaQueryFromInspector
Description	Gets an agenda query from an inspector. The inspector is available from an `AgendaSearchResults.`
Parameters	`osid.rules.check.AgendaQueryInspector`	`agendaQueryInspector`	an agenda query inspector
Return	`osid.rules.check.AgendaQuery`		the agenda query
Errors	NULL_ARGUMENT		`agendaQueryInspector` is `null`
Errors	UNSUPPORTED		`agendaQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.