OSID - osid.course.CourseOfferingSearchSession Service Interface Definition

Interface	osid.course.CourseOfferingSearchSession
Implements	`osid.course.CourseOfferingQuerySession`
Description	This session provides methods for searching among `CourseOffering` objects. The search query is constructed using the `CourseOfferingQuery.` `getCourseOfferingsByQuery()` is the basic search method and returns a list of `CourseOfferings.` A more advanced search may be performed with `getCourseOfferingsBySearch().` It accepts a `CourseOfferingSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCourseOfferingsBySearch()` returns a `CourseOfferingSearchResults` that can be used to access the resulting `CourseOfferingList` or be used to perform a search within the result set through `CourseOfferingSearch.` This session defines views that offer differing behaviors for searching. federated course catalog view: searches include course offerings in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to course offerings in this course catalog Course Offerings may have a query record indicated by their respective record types. The queryrecord is accessed via the `CourseOfferingQuery.`
Method	getCourseOfferingSearch
Description	Gets a course offering search.
Return	`osid.course.CourseOfferingSearch`		the course offering search
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingSearchOrder
Description	Gets a course offering search order. The `CourseOfferingSearchOrder` is supplied to a `CourseOfferingSearch` to specify the ordering of results.
Return	`osid.course.CourseOfferingSearchOrder`		the course offering search order
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.CourseOfferingQuery`	`courseOfferingQuery`	the course offering query
Parameters	`osid.course.CourseOfferingSearch`	`courseOfferingSearch`	the course offering search
Return	`osid.course.CourseOfferingSearchResults`		the course offering search results
Errors	NULL_ARGUMENT		`courseOfferingQuery` or `courseOfferingSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseOfferingQuery` or `courseOfferingSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingQueryFromInspector
Description	Gets a course offering query from an inspector. The inspector is available from a `CourseOfferingSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`courseOfferingQueryInspector`	a course offering query inspector
Return	`osid.course.CourseOfferingQuery`		the course offering query
Errors	NULL_ARGUMENT		`courseOfferingQueryInspector` is `null`
Errors	UNSUPPORTED		`courseOfferingQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.