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

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

MethodgetPrograms
Description

Gets the program list resulting from a search.

Returnosid.course.program.ProgramListthe program list
ErrorsILLEGAL_STATEthe program list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProgramQueryInspector
Description

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

Returnosid.course.program.ProgramQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProgramSearchResultsRecord
Description

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

Parametersosid.type.TypeprogramSearchRecordTypea program search record type
Returnosid.course.program.records.ProgramSearchResultsRecordthe program search results record
ErrorsNULL_ARGUMENT programSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programSearchRecordType) is false
CompliancemandatoryThis method must be implemented.