OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.ActivitySearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetActivities
Description

Gets the activity list resulting from a search.

Returnosid.course.ActivityListthe activity list
ErrorsILLEGAL_STATEthe activity list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetActivityQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.course.ActivityQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchResultsRecord
Description

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

Parametersosid.type.TypeactivitySearchRecordTypea activity search record type
Returnosid.course.records.ActivitySearchResultsRecordthe activity search interface
ErrorsNULL_ARGUMENT activitySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activitySearchRecordType) is false
CompliancemandatoryThis method must be implemented.