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

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

MethodgetActivityUnits
Description

Gets the activity unit list resulting from a search.

Returnosid.course.ActivityUnitListthe activity unit list
ErrorsILLEGAL_STATEthe activity unit list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitQueryInspector
Description

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

Returnosid.course.ActivityUnitQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitSearchResultsRecord
Description

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

Parametersosid.type.TypeactivityUnitSearchRecordTypea activity unit search record type
Returnosid.course.records.ActivityUnitSearchResultsRecordthe activity unit search results record
ErrorsNULL_ARGUMENT activityUnitSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityUnitSearchRecordType) is false
CompliancemandatoryThis method must be implemented.