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

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

MethodgetRequisites
Description

Gets the requisite list resulting from a search.

Returnosid.course.requisite.RequisiteListthe requisite list
ErrorsILLEGAL_STATEthe requisite list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRequisiteQueryInspector
Description

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

Returnosid.course.requisite.RequisiteQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetRequisiteSearchResultsRecord
Description

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

Parametersosid.type.TyperequisiteSearchRecordTypea requisite search record type
Returnosid.course.requisite.records.RequisiteSearchResultsRecordthe requisite search results record
ErrorsNULL_ARGUMENT requisiteSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requisiteSearchRecordType) is false
CompliancemandatoryThis method must be implemented.