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

Interface	osid.course.registration.request.RegistrationRequestItemSearchSession
Implements	`osid.course.registration.request.RegistrationRequestItemQuerySession`
Used By	`osid.course.registration.request.RegistrationRequestManager`
Used By	`osid.course.registration.request.RegistrationRequestProxyManager`
Description	This session provides methods for searching among `RegistrationRequestItems` . The search query is constructed using the `RegistrationRequestItemQuery` . `getRegistrationRequestItemsByQuery()` is the basic search method and returns a list of `RegistrationRequestItems` . A more advanced search may be performed with `getRegistrationRequestItemsBySearch()` .It accepts a `RegistrationRequestItemSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRegistrationRequestItemsBySearch()` returns a `RegistrationRequestItemSearchResults` that can be used to access the resulting `RegistrationRequestItemList` or be used to perform a search within the result set through `RegistrationRequestItemSearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include registration request items 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 request items in this course catalog Registration Request Items may have a query record indicated by their respective record types. The quer `y record is accessed via the RegistrationRequestItemQuery` .
Method	getRegistrationRequestItemSearch
Description	Gets a registration request item search.
Return	`osid.course.registration.request.RegistrationRequestItemSearch`		the registration request item search
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemSearchOrder
Description	Gets a registration request item search order. The `RegistrationRequestItemSearchOrder` is supplied to a `RegistrationRequestItemSearch` to specify the ordering of results.
Return	`osid.course.registration.request.RegistrationRequestItemSearchOrder`		the registration request item search order
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.registration.request.RegistrationRequestItemQuery`	`registrationRequestItemQuery`	the registration request item query
Parameters	`osid.course.registration.request.RegistrationRequestItemSearch`	`registrationRequestItemSearch`	the registration request item search
Return	`osid.course.registration.request.RegistrationRequestItemSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`registrationRequestItemQuery` or `registrationRequestItemSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationRequestItemQuery` or `registrationRequestItemSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemQueryFromInspector
Description	Gets a registration request item query from an inspector. The inspector is available from a `RegistrationRequestItemSearchResults` .
Parameters	`osid.course.registration.request.RegistrationRequestItemQueryInspector`	`registrationRequestItemQueryInspector`	a registration request item query inspector
Return	`osid.course.registration.request.RegistrationRequestItemQuery`		the registration request item query
Errors	NULL_ARGUMENT		`registrationRequestItemQueryInspector` is `null`
Errors	UNSUPPORTED		`registrationRequestItemQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.