Interface | osid.course.syllabus.DocetSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing docet searches. | ||
Method | searchAmongDocets | ||
Description |
Execute this search among the given list of docets. | ||
Parameters | osid.id.IdList | docetIds | list of docets |
Errors | NULL_ARGUMENT | docetIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderDocetResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.course.syllabus.DocetSearchOrder | docetSearchOrder | docet search order |
Errors | NULL_ARGUMENT | docetSearchOrder is null | |
UNSUPPORTED | docetSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDocetSearchRecord | ||
Description |
Gets the docet search record corresponding to the given
docet search record | ||
Parameters | osid.type.Type | docetSearchRecordType | a docet search record type |
Return | osid.course.syllabus.records.DocetSearchRecord | the docet search record | |
Errors | NULL_ARGUMENT | docetSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(docetSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |