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

Interface	osid.course.registration.ActivityRegistrationSearchSession
Implements	`osid.course.registration.ActivityRegistrationQuerySession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session provides methods for searching among `ActivityRegistration` objects. The search query is constructed using the `ActivityRegistrationQuery` . `getActivityRegistrationsByQuery()` is the basic search method and returns a list of `ActivityRegistrations` . A more advanced search may be performed with `getActivityRegistrationsBySearch()` . It accepts an `ActivityRegistrationSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getActivityRegistrationsBySearch()` returns an `ActivityRegistrationSearchResults` that can be used to access the resulting `ActivityRegistrationList` or be used to perform a search within the result set through `ActivityRegistrationSearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include activity 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 activity registrations in this course catalog Activity Registrations may have a query record indicated by their respective record types. The query record is accessed via the `ActivityRegistrationQuery` .
Method	getActivityRegistrationSearch
Description	Gets an activity registration search.
Return	`osid.course.registration.ActivityRegistrationSearch`		the activity registration search
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationSearchOrder
Description	Gets an activity search order. The `ActivityRegistrationSearchOrder` is supplied to an `ActivityRegistrationSearch` to specify the ordering of results.
Return	`osid.course.registration.ActivityRegistrationSearchOrder`		the activity registration search order
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.registration.ActivityRegistrationQuery`	`activityRegistrationQuery`	the activity registration query
Parameters	`osid.course.registration.ActivityRegistrationSearch`	`activityRegistrationSearch`	the activity registration search
Return	`osid.course.registration.ActivityRegistrationSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`activityRegistrationQuery` or `activityRegistrationSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityRegistrationQuery` or `activityRegistrationSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationQueryFromInspector
Description	Gets an activity registration query from an inspector. The inspector is available from an `ActivityRegistrationSearchResults` .
Parameters	`osid.assessment.ItemQueryInspector`	`activityRegistrationQueryInspector`	an activity registration query inspector
Return	`osid.course.registration.ActivityRegistrationQuery`		the activity registration query
Errors	NULL_ARGUMENT		`activityRegistrationQueryInspector` is `null`
Errors	UNSUPPORTED		`activityRegistrationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.