OSID - osid.learning.ActivitySearchSession Service Interface Definition

Interface	osid.learning.ActivitySearchSession
Implements	`osid.learning.ActivityQuerySession`
Description	This session provides methods for searching `Activity` objects. The search query is constructed using the `ActivityQuery.` The activity record `Type` also specifies the record for the activity query. `getActivitiesByQuery()` is the basic search method and returns a list of `Activities.` A more advanced search may be performed with `getActivitiesBySearch().` It accepts a `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 objective bank view: searches include activities in objective banks of which this objective bank is a ancestor in the objective bank hierarchy isolated objective bank view: searches are restricted to activities in this objective bank 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.learning.ActivitySearch`		the activity search
Compliance	`mandatory`		This method must be implemented.
Method	getActivitySearchOrder
Description	Gets an activity search order. The `ActivitySearchOrder` is supplied to a `ActivitySearch` to specify the ordering of results.
Return	`osid.learning.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.learning.ActivityQuery`	`activityQuery`	the activity query
Parameters	`osid.learning.ActivitySearch`	`activitiesearch`	the activity search
Return	`osid.learning.ActivitySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`activityQuery` or `activitiesearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activitiesearch` or `activityQuery` 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.learning.ActivityQueryInspector`	`activityQueryInspector`	an activity bank query inspector
Return	`osid.learning.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.