OSID - osid.course.CourseCatalogSearchSession Service Interface Definition

Interface	osid.course.CourseCatalogSearchSession
Implements	`osid.course.CourseCatalogQuerySession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session provides methods for searching among `CourseCatalogs` . The search query is constructed using the `CourseCatalogQuery` . `getCourseCatalogsByQuery()` is the basic search method and returns a list of `CourseCatalogs` . A more advanced search may be performed with `getCourseCatalogsBySearch()` .It accepts a `CourseCatalogSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCourseCatalogsBySearch()` returns a `CourseCatalogSearchResults` that can be used to access the resulting `CourseCatalogList` or be used to perform a search within the result set through `CourseCatalogSearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include course catalogs 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 catalogs in this course catalog Course catalogs may have a query record indicated by their respective record types. The query record is accessed via the `CourseCatalogQuery` .
Method	getCourseCatalogSearch
Description	Gets a course catalog search.
Return	`osid.course.CourseCatalogSearch`		the course catalog search
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogSearchOrder
Description	Gets a course catalog search order. The `CourseCatalogSearchOrder` is supplied to a `CourseCatalogSearch` to specify the ordering of results.
Return	`osid.course.CourseCatalogSearchOrder`		the course catalog search order
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.CourseCatalogQuery`	`courseCatalogQuery`	the course catalog query
Parameters	`osid.course.CourseCatalogSearch`	`courseCatalogSearch`	the course catalog search
Return	`osid.course.CourseCatalogSearchResults`		the course catalog search results
Errors	NULL_ARGUMENT		`courseCatalogQuery` or `courseCatalogSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseCatalogQuery` or `courseCatalogSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogQueryFromInspector
Description	Gets a course catalog query from an inspector. The inspector is available from a `CourseCatalogSearchResults` .
Parameters	`osid.course.CourseCatalogQueryInspector`	`courseCatalogQueryInspector`	a course catalog query inspector
Return	`osid.course.CourseCatalogQuery`		the course catalog query
Errors	NULL_ARGUMENT		`courseCatalogQueryInspector` is `null`
Errors	UNSUPPORTED		`courseCatalogQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.