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

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

MethodgetActivities
Description

Gets the activity list resulting from the search.

Returnosid.learning.ActivityListthe activity list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetActivityQueryInspector
Description

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

Returnosid.learning.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.TypeactivitiesearchRecordTypean activity search record type
Returnosid.learning.records.ActivitySearchResultsRecordthe activity search results record
ErrorsNULL_ARGUMENT activitiesearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasSearchRecordType(activitiesearchRecordType) is false
CompliancemandatoryThis method must be implemented.