OSID Logo
OSID Specifications
course syllabus package
Version 3.0.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.IdListdocetIdslist of docets
ErrorsNULL_ARGUMENTdocetIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDocetResults
Description

Specify an ordering to the search results.

Parametersosid.course.syllabus.DocetSearchOrderdocetSearchOrderdocet search order
ErrorsNULL_ARGUMENTdocetSearchOrder is null
UNSUPPORTEDdocetSearchOrder is not of this service
CompliancemandatoryThis 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.TypedocetSearchRecordTypea docet search record type
Returnosid.course.syllabus.records.DocetSearchRecordthe docet search record
ErrorsNULL_ARGUMENTdocetSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(docetSearchRecordType) is false
CompliancemandatoryThis method must be implemented.