OSID - osid.course.registration.CourseRegistrationSearchSession Service Interface Definition

Interface	osid.course.registration.CourseRegistrationSearchSession
Implements	`osid.course.registration.CourseRegistrationQuerySession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session provides methods for searching among `CourseRegistrations` . The search query is constructed using the `CourseRegistrationQuery` . `getCourseRegistrationsByQuery()` is the basic search method and returns a list of `CourseRegistrations` . A more advanced search may be performed with `getCourseRegistrationsBySearch()` . It accepts a `CourseRegistrationSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCourseRegistrationsBySearch()` returns a `CourseRegistrationSearchResults` that can be used to access the resulting `CourseRegistrationList` or be used to perform a search within the result set through `CourseRegistrationSearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include course registrations 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 registrations in this course catalog Course Registrations may have a query record indicated by their respective record types. The query record is access `ed via the CourseRegistrationQuery` .
Method	getCourseRegistrationSearch
Description	Gets a course registration search.
Return	`osid.course.registration.CourseRegistrationSearch`		the course registration search
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationSearchOrder
Description	Gets a course registration search order. The `CourseRegistrationSearchOrder` is supplied to a `CourseRegistrationSearch` to specify the ordering of results.
Return	`osid.course.registration.CourseRegistrationSearchOrder`		the course registration search order
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.registration.CourseRegistrationQuery`	`courseRegistrationQuery`	the course registration query
Parameters	`osid.course.registration.CourseRegistrationSearch`	`courseRegistrationSearch`	the course registration search
Return	`osid.course.registration.CourseRegistrationSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`courseRegistrationQuery` or `courseRegistrationSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseRegistrationQuery` or `courseRegistrationSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationQueryFromInspector
Description	Gets a course registration query from an inspector. The inspector is available from a `CourseRegistrationSearchResults` .
Parameters	`osid.course.registration.CourseRegistrationQueryInspector`	`courseRegistrationQueryInspector`	a course registration query inspector
Return	`osid.course.registration.CourseRegistrationQuery`		the course registration query
Errors	NULL_ARGUMENT		`courseRegistrationQueryInspector` is `null`
Errors	UNSUPPORTED		`courseRegistrationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.