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

Interface	osid.course.registration.RegistrationSearchSession
Implements	`osid.course.registration.RegistrationQuerySession`
Description	This session provides methods for searching among `Registration` objects. The search query is constructed using the `RegistrationQuery.` `getRegistrationsByQuery()` is the basic search method and returns a list of `Registrations.` A more advanced search may be performed with `getRegistrationsBySearch().` It accepts a `RegistrationSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRegistrationsBySearch()` returns a `RegistrationSearchResults` that can be used to access the resulting `RegistrationList` or be used to perform a search within the result set through `RegistrationSearch.` This session defines views that offer differing behaviors for searching. federated course catalog view: searches include 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 registrations in this course catalog Registrations may have a query record indicated by their respective record types. The query record is accessed via the `RegistrationQuery.`
Method	getRegistrationSearch
Description	Gets a registration search.
Return	`osid.course.registration.RegistrationSearch`		the registration search
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationSearchOrder
Description	Gets a registration search order. The `RegistrationSearchOrder` is supplied to a `RegistrationSearch` to specify the ordering of results.
Return	`osid.course.registration.RegistrationSearchOrder`		the registration search order
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.registration.RegistrationQuery`	`registrationQuery`	the registration query
Parameters	`osid.course.registration.RegistrationSearch`	`registrationSearch`	the registration search
Return	`osid.course.registration.RegistrationSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`registrationQuery` or `registrationSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationQuery` or `registrationSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationQueryFromInspector
Description	Gets a registration query from an inspector. The inspector is available from a `RegistrationSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`registrationQueryInspector`	a registration query inspector
Return	`osid.course.registration.RegistrationQuery`		the registration query
Errors	NULL_ARGUMENT		`registrationQueryInspector` is `null`
Errors	UNSUPPORTED		`registrationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.