OSID - osid.course.ActivitySearchSession Service Interface Definition

Interface	osid.course.ActivitySearchSession
Implements	`osid.course.ActivityQuerySession`
Description	This session provides methods for searching among `Activity` objects. The search query is constructed using the `ActivityQuery.` `getActivitiesByQuery()` is the basic search method and returns a list of `Activitys.` A more advanced search may be performed with `getActivitysBySearch().` It accepts an `ActivitySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getActivitiesBySearch()` returns an `ActivitySearchResults` that can be used to access the resulting `ActivityList` or be used to perform a search within the result set through `ActivitySearch.` This session defines views that offer differing behaviors for searching. federated course catalog view: searches include activities in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to activities in this course catalog Activities may have a query record indicated by their respective record types. The query record is accessed via the `ActivityQuery.`
Method	getActivitySearch
Description	Gets an activity search.
Return	`osid.course.ActivitySearch`		the activity search
Compliance	`mandatory`		This method must be implemented.
Method	getActivitySearchOrder
Description	Gets an activity search order. The `ActivitySearchOrder` is supplied to an `ActivitySearch` to specify the ordering of results.
Return	`osid.course.ActivitySearchOrder`		the activity search order
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.ActivityQuery`	`activityQuery`	the activity query
Parameters	`osid.course.ActivitySearch`	`activitySearch`	the activity search
Return	`osid.course.ActivitySearchResults`		the activity search results
Errors	NULL_ARGUMENT		`activityQuery` or `activitySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityQuery` or `activitySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActivityQueryFromInspector
Description	Gets an activity query from an inspector. The inspector is available from an `ActivitySearchResults.`
Parameters	`osid.course.ActivityQueryInspector`	`activityQueryInspector`	an activity query inspector
Return	`osid.course.ActivityQuery`		the activity query
Errors	NULL_ARGUMENT		`activityQueryInspector` is `null`
Errors	UNSUPPORTED		`activityQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.