OSID - osid.course.registration.request.RegistrationRequestSearchSession Service Interface Definition

Interface	osid.course.registration.request.RegistrationRequestSearchSession
Implements	`osid.course.registration.request.RegistrationRequestQuerySession`
Used By	`osid.course.registration.request.RegistrationRequestManager`
Used By	`osid.course.registration.request.RegistrationRequestProxyManager`
Description	This session provides methods for searching among `RegistrationRequests` . The search query is constructed using the `RegistrationRequestQuery` . `getRegistrationRequestsByQuery()` is the basic search method and returns a list of `RegistrationRequests` . A more advanced search may be performed with `getRegistrationRequestsBySearch()` . It accepts a `RegistrationRequestSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRegistrationRequestsBySearch()` returns a `RegistrationRequestSearchResults` that can be used to access the resulting `RegistrationRequestList` or be used to perform a search within the result set through `RegistrationRequestSearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include registration requests in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to registration requests in this course catalog Registration Requests may have a query record indicated by their respective record types. The query record is acc `essed via the RegistrationRequestQuery` .
Method	getRegistrationRequestSearch
Description	Gets a registration request search.
Return	`osid.course.registration.request.RegistrationRequestSearch`		the registration request search
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestSearchOrder
Description	Gets a registration request search order. The `RegistrationRequestSearchOrder` is supplied to a `RegistrationRequestSearch` to specify the ordering of results.
Return	`osid.course.registration.request.RegistrationRequestSearchOrder`		the registration request search order
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.registration.request.RegistrationRequestQuery`	`registrationRequestQuery`	the registration request query
Parameters	`osid.course.registration.request.RegistrationRequestSearch`	`registrationRequestSearch`	the registration request search
Return	`osid.course.registration.request.RegistrationRequestSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`registrationRequestQuery` or `registrationRequestSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationRequestQuery` or `registrationRequestSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestQueryFromInspector
Description	Gets a registration request query from an inspector. The inspector is available from a `RegistrationRequestSearchResults` .
Parameters	`osid.course.registration.request.RegistrationRequestQueryInspector`	`registrationRequestQueryInspector`	a registration request query inspector
Return	`osid.course.registration.request.RegistrationRequestQuery`		the registration request query
Errors	NULL_ARGUMENT		`registrationRequestQueryInspector` is `null`
Errors	UNSUPPORTED		`registrationRequestQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.