OSID Logo
OSID Specifications
course package
Version 3.1.0
Interfaceosid.course.ActivityUnitSearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.ActivityUnitSearchSession
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.ActivityUnitList the activity unit list
ErrorsILLEGAL_STATE the activity unit list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetActivityUnitQueryInspector
Description

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

Returnosid.course.ActivityUnitQueryInspector the query inspector
Compliancemandatory This 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.TypeactivityUnitSearchRecordType an activity unit search record type
Returnosid.course.records.ActivityUnitSearchResultsRecord the activity unit search results record
ErrorsNULL_ARGUMENT activityUnitSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(activityUnitSearchRecordType) is false
Compliancemandatory This method must be implemented.