OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.ProgramSearch
Implementsosid.OsidSearch
Description

The search interface for governing program searches.

MethodsearchAmongPrograms
Description

Execute this search among the given list of programs.

Parametersosid.id.IdListprogramIdslist of program Ids
ErrorsNULL_ARGUMENT programIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProgramResults
Description

Specify an ordering to the search results.

Parametersosid.course.program.ProgramSearchOrderprogramSearchOrderprogram search order
ErrorsNULL_ARGUMENT programSearchOrder is null
UNSUPPORTED programSearchOrder is not of this service
CompliancemandatoryThis 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.TypeprogramSearchRecordTypea program search record type
Returnosid.course.program.records.ProgramSearchRecordthe program search record
ErrorsNULL_ARGUMENT programSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programSearchRecordType) is false
CompliancemandatoryThis method must be implemented.