OSID - osid.course.requisite.RequisiteSearchSession Service Interface Definition

Interface	osid.course.requisite.RequisiteSearchSession
Implements	`osid.course.requisite.RequisiteQuerySession`
Used By	`osid.course.requisite.CourseRequisiteManager`
Used By	`osid.course.requisite.CourseRequisiteProxyManager`
Description	This session provides methods for searching among `Requisites`. The search query is constructed using the `RequisiteQuery`. `getRequisitesByQuery()` is the basic search method and returns a list of `Requisites`. A more advanced search may be performed with `getRequisitesBySearch()`.It accepts a `RequisiteSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRequisitesBySearch()` returns a `RequisiteSearchResults` that can be used to access the resulting `RequisiteList` or be used to perform a search within the result set through `RequisiteSearch`. This session defines views that offer differing behaviors for searching. federated course catalog view: searches include requisites in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to courses in this course catalog Requisites may have a query record indicated by their respective record types. The query record is accessed via the `RequisiteQuery`.
Method	getRequisiteSearch
Description	Gets a requisite search.
Return	`osid.course.requisite.RequisiteSearch`		the requisite search
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteSearchOrder
Description	Gets a requisite search order. The `RequisiteSearchOrder` is supplied to a `RequisiteSearch` to specify the ordering of results.
Return	`osid.course.requisite.RequisiteSearchOrder`		the requisite search order
Compliance	`mandatory`		This method must be implemented.
Method	getRequisitesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.requisite.RequisiteQuery`	`requisiteQuery`	the requisite query
Parameters	`osid.course.requisite.RequisiteSearch`	`requisiteSearch`	the requisite search
Return	`osid.course.requisite.RequisiteSearchResults`		the requisite search results
Errors	NULL_ARGUMENT		`requisiteQuery` or `requisiteSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`requisiteQuery` or `requisiteSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteQueryFromInspector
Description	Gets a requisite query from an inspector. The inspector is available from a `RequisiteSearchResults`.
Parameters	`osid.course.requisite.RequisiteQueryInspector`	`requisiteQueryInspector`	a requisite query inspector
Return	`osid.course.requisite.RequisiteQuery`		the requisite query
Errors	NULL_ARGUMENT		`requisiteQueryInspector` is `null`
Errors	UNSUPPORTED		`requisiteQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.