OSID Logo
OSID Specifications
course syllabus package
Version 3.1.0
Interfaceosid.course.syllabus.SyllabusSearch
Implementsosid.OsidSearch
Used Byosid.course.syllabus.SyllabusSearchSession
Description

The search interface for governing syllabus searches.

MethodsearchAmongSyllabi
Description

Execute this search among the given list of syllabi.

Parametersosid.id.IdListsyllabusIds list of syllabi
ErrorsNULL_ARGUMENT syllabusIds is null
Compliancemandatory This method must be implemented.
MethodorderSyllabusResults
Description

Specify an ordering to the search results.

Parametersosid.course.syllabus.SyllabusSearchOrdersyllabusSearchOrder syllabus search order
ErrorsNULL_ARGUMENT syllabusSearchOrder is null
UNSUPPORTED syllabusSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetSyllabusSearchRecord
Description

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

Parametersosid.type.TypesyllabusSearchRecordType a syllabus search record type
Returnosid.course.syllabus.records.SyllabusSearchRecord the syllabus search record
ErrorsNULL_ARGUMENT syllabusSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(syllabusSearchRecordType) is false
Compliancemandatory This method must be implemented.