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

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

MethodgetDocets
Description

Gets the docet list resulting from a search.

Returnosid.course.syllabus.DocetListthe docet list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDocetQueryInspector
Description

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

Returnosid.course.syllabus.DocetQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetDocetSearchResultsRecord
Description

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

Parametersosid.type.TypedocetSearchRecordTypea docet search record type
Returnosid.course.syllabus.records.DocetSearchResultsRecordthe docet search results record
ErrorsNULL_ARGUMENT DocetSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(docetSearchRecordType) is false
CompliancemandatoryThis method must be implemented.