OSID - osid.course.CourseSearchSession Service Interface Definition

Interface	osid.course.CourseSearchSession
Implements	`osid.course.CourseQuerySession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session provides methods for searching among `Courses` . The search query is constructed using the `CourseQuery` . `getCoursesByQuery()` is the basic search method and returns a list of `Courses` . A more advanced search may be performed with `getCoursesBySearch()` .It accepts a `CourseSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCoursesBySearch()` returns a `CourseSearchResults` that can be used to access the resulting `CourseList` or be used to perform a search within the result set through `CourseSearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include courses 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 Courses may have a query record indicated by their respective record types. The query record is accessed via the `CourseQuery` .
Method	getCourseSearch
Description	Gets a course search.
Return	`osid.course.CourseSearch`		the course search
Compliance	`mandatory`		This method must be implemented.
Method	getCourseSearchOrder
Description	Gets a course search order. The `CourseSearchOrder` is supplied to a `CourseSearch` to specify the ordering of results.
Return	`osid.course.CourseSearchOrder`		the course search order
Compliance	`mandatory`		This method must be implemented.
Method	getCoursesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.CourseQuery`	`courseQuery`	the course query
Parameters	`osid.course.CourseSearch`	`courseSearch`	the course search
Return	`osid.course.CourseSearchResults`		the course search results
Errors	NULL_ARGUMENT		`courseQuery` or `courseSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseQuery` or `courseSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseQueryFromInspector
Description	Gets a course query from an inspector. The inspector is available from a `CourseSearchResults` .
Parameters	`osid.course.CourseQueryInspector`	`courseQueryInspector`	a course query inspector
Return	`osid.course.CourseQuery`		the course query
Errors	NULL_ARGUMENT		`courseQueryInspector` is `null`
Errors	UNSUPPORTED		`courseQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.