OSID Logo
OSID Specifications
course program package
Version 3.1.0
Interfaceosid.course.program.ProgramSearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.program.ProgramSearchSession
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.ProgramList the program list
ErrorsILLEGAL_STATE the program list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetProgramQueryInspector
Description

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

Returnosid.course.program.ProgramQueryInspector the query inspector
Compliancemandatory This 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.TypeprogramSearchRecordType a program search record type
Returnosid.course.program.records.ProgramSearchResultsRecord the program search results record
ErrorsNULL_ARGUMENT programSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(programSearchRecordType) is false
Compliancemandatory This method must be implemented.