OSID Logo
OSID Specifications
course program package
Version 3.1.0
Interfaceosid.course.program.ProgramSearch
Implementsosid.OsidSearch
Used Byosid.course.program.ProgramSearchSession
Description

The search interface for governing program searches.

MethodsearchAmongPrograms
Description

Execute this search among the given list of programs.

Parametersosid.id.IdListprogramIds list of program Ids
ErrorsNULL_ARGUMENT programIds is null
Compliancemandatory This method must be implemented.
MethodorderProgramResults
Description

Specify an ordering to the search results.

Parametersosid.course.program.ProgramSearchOrderprogramSearchOrder program search order
ErrorsNULL_ARGUMENT programSearchOrder is null
UNSUPPORTED programSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetProgramSearchRecord
Description

Gets the program search 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.ProgramSearchRecord the program search record
ErrorsNULL_ARGUMENT programSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(programSearchRecordType) is false
Compliancemandatory This method must be implemented.