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

Interface	osid.course.registration.ActivityBundleSearchSession
Implements	`osid.course.registration.ActivityBundleQuerySession`
Description	This session provides methods for searching among `ActivityBundle` objects. The search query is constructed using the `ActivityBundleQuery.` `getActivityBundlesByQuery()` is the basic search method and returns a list of `ActivityBundles.` A more advanced search may be performed with `getActivityBundlesBySearch().` It accepts an `ActivityBundleSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getActivityBundlesBySearch()` returns an `ActivityBundleSearchResults` that can be used to access the resulting `ActivityBundleList` or be used to perform a search within the result set through `ActivityBundleSearch.` This session defines views that offer differing behaviors for searching. federated course catalog view: searches include activity bundles 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 bundles in this course catalog Activity Bundles may have a query record indicated by their respective record types. The query record is accessed via the `ActivityBundleQuery.`
Method	getActivityBundleSearch
Description	Gets an activity bundle search.
Return	`osid.course.registration.ActivityBundleSearch`		the activity bundle search
Compliance	`mandatory`		This method must be implemented.
Method	getActivityBundleSearchOrder
Description	Gets an activity search order. The `ActivityBundleSearchOrder` is supplied to an `ActivityBundleSearch` to specify the ordering of results.
Return	`osid.course.registration.ActivityBundleSearchOrder`		the activity bundle search order
Compliance	`mandatory`		This method must be implemented.
Method	getActivityBundlesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.registration.ActivityBundleQuery`	`activityBundleQuery`	the activity bundle query
Parameters	`osid.course.registration.ActivityBundleSearch`	`activityBundleSearch`	the activity bundle search
Return	`osid.course.registration.ActivityBundleSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`activityBundleQuery` or `activityBundleSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityBundleQuery` or `activityBundleSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActivityBundleQueryFromInspector
Description	Gets an activity bundle query from an inspector. The inspector is available from an `ActivityBundleSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`activityBundleQueryInspector`	a query inspector
Return	`osid.course.registration.ActivityBundleQuery`		the activity bundle query
Errors	NULL_ARGUMENT		`activityBundleQueryInspector` is `null`
Errors	UNSUPPORTED		`activityBundleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.