Interface | osid.course.syllabus.DocetSearchSession | ||
---|---|---|---|
Implements | osid.course.syllabus.DocetQuerySession | ||
Description |
This session provides methods for searching Docetsmay have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getDocetSearch | ||
Description |
Gets a docet search. | ||
Return | osid.course.syllabus.DocetSearch | the docet search | |
Compliance | mandatory | This method must be implemented. | |
Method | getDocetSearchOrder | ||
Description |
Gets a docet search order. The | ||
Return | osid.course.syllabus.DocetSearchOrder | the docet search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getDocetsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.course.syllabus.DocetQuery | docetQuery | the docet query |
osid.course.syllabus.DocetSearch | docetSearch | the docet search | |
Return | osid.course.syllabus.DocetSearchResults | the docet search results | |
Errors | NULL_ARGUMENT | docetQuery or docetSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | docetQuery or docetSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDocetQueryFromInspector | ||
Description |
Gets a docet query from an inspector. The inspector is
available from an | ||
Parameters | osid.course.syllabus.DocetQueryInspector | docetQueryInspector | a docet query inspector |
Return | osid.course.syllabus.DocetQuery | the course catalog query | |
Errors | NULL_ARGUMENT | docetQueryInspector is null | |
UNSUPPORTED | docetQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |