OSID Logo
OSID Specifications
course syllabus package
Version 3.1.0
Interfaceosid.course.syllabus.DocetSearch
Implementsosid.OsidSearch
Used Byosid.course.syllabus.DocetSearchSession
Description

The search interface for governing docet searches.

MethodsearchAmongDocets
Description

Execute this search among the given list of docets.

Parametersosid.id.IdListdocetIds list of docets
ErrorsNULL_ARGUMENT docetIds is null
Compliancemandatory This method must be implemented.
MethodorderDocetResults
Description

Specify an ordering to the search results.

Parametersosid.course.syllabus.DocetSearchOrderdocetSearchOrder docet search order
ErrorsNULL_ARGUMENT docetSearchOrder is null
UNSUPPORTED docetSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetDocetSearchRecord
Description

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

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