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

Interface	osid.course.registration.RegistrationTargetSearchSession
Implements	`osid.course.registration.RegistrationTargetQuerySession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session provides methods for searching among `RegistrationTargets` . The search query is constructed using the `RegistrationTargetQuery` . `getRegistrationTargetsByQuery()` is the basic search method and returns a list of `RegistrationTargets` . A more advanced search may be performed with `getRegistrationTargetsBySearch()` . It accepts a `RegistrationTargetSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRegistrationTargetsBySearch()` returns a `RegistrationTargetSearchResults` that can be used to access the resulting `RegistrationTargetList` or be used to perform a search within the result set through `RegistrationTargetSearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include registration targets 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 targets in this course catalog Registration Targets may have a query record indicated by their respective record types. The query record is access `ed via the RegistrationTargetQuery` .
Method	getRegistrationTargetSearch
Description	Gets a registration target search.
Return	`osid.course.registration.RegistrationTargetSearch`		the registration target search
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetSearchOrder
Description	Gets a registration target search order. The `RegistrationTargetSearchOrder` is supplied to a `RegistrationTargetSearch` to specify the ordering of results.
Return	`osid.course.registration.RegistrationTargetSearchOrder`		the registration target search order
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.registration.RegistrationTargetQuery`	`registrationTargetQuery`	the registration target query
Parameters	`osid.course.registration.RegistrationTargetSearch`	`registrationTargetSearch`	the registration target search
Return	`osid.course.registration.RegistrationTargetSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`registrationTargetQuery` or `registrationTargetSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationTargetQuery` or `registrationTargetSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetQueryFromInspector
Description	Gets a registration target query from an inspector. The inspector is available from a `RegistrationTargetSearchResults` .
Parameters	`osid.course.registration.RegistrationTargetQueryInspector`	`registrationTargetQueryInspector`	a registration target query inspector
Return	`osid.course.registration.RegistrationTargetQuery`		the registration target query
Errors	NULL_ARGUMENT		`registrationTargetQueryInspector` is `null`
Errors	UNSUPPORTED		`registrationTargetQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.