OSID Logo
OSID Specifications
course package
Version 3.0.0
Interfaceosid.course.ActivitySearch
Implementsosid.OsidSearch
Used Byosid.course.ActivitySearchSession
Description

The search interface for governing activity searches.

MethodsearchAmongActivities
Description

Execute this search among the given list of activities.

Parametersosid.id.IdListactivityIdslist of activities
ErrorsNULL_ARGUMENTactivityIds is null
CompliancemandatoryThis method must be implemented.
MethodorderActivityResults
Description

Specify an ordering to the search results.

Parametersosid.course.ActivitySearchOrderactivitySearchOrderactivity search order
ErrorsNULL_ARGUMENTactivitySearchOrder is null
UNSUPPORTEDactivitySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchRecord
Description

Gets the activity search record corresponding to the given activity search record Type . This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeactivitySearchRecordTypean activity search record type
Returnosid.course.records.ActivitySearchRecordthe activity search record
ErrorsNULL_ARGUMENTactivitySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(activitySearchRecordType) is false
CompliancemandatoryThis method must be implemented.