OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.ActivitySearchSession
Implementsosid.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.

MethodgetActivitySearch
Description

Gets an activity search.

Returnosid.course.ActivitySearchthe activity search
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchOrder
Description

Gets an activity search order. The ActivitySearchOrder is supplied to an ActivitySearch to specify the ordering of results.

Returnosid.course.ActivitySearchOrderthe activity search order
CompliancemandatoryThis method must be implemented.
MethodgetActivitiesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.course.ActivityQueryactivityQuerythe activity query
osid.course.ActivitySearchactivitySearchthe activity search
Returnosid.course.ActivitySearchResultsthe activity search results
ErrorsNULL_ARGUMENT activityQuery or activitySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED activityQuery or activitySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActivityQueryFromInspector
Description

Gets an activity query from an inspector. The inspector is available from an ActivitySearchResults.

Parametersosid.course.ActivityQueryInspectoractivityQueryInspectoran activity query inspector
Returnosid.course.ActivityQuerythe activity query
ErrorsNULL_ARGUMENT activityQueryInspector is null
UNSUPPORTED activityQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.