OSID Specifications
course syllabus package
Version 3.1.0
course syllabus package
Version 3.1.0
| Interface | osid.course.syllabus.DocetSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.course.syllabus.DocetSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getDocets | ||
| Description |
Gets the docet list resulting from a search. | ||
| Return | osid.course.syllabus.DocetList | the docet list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDocetQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.course.syllabus.DocetQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDocetSearchResultsRecord | ||
| Description |
Gets the docet search results record corresponding to the given docet search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | docetSearchRecordType | a docet search record type |
| Return | osid.course.syllabus.records.DocetSearchResultsRecord | the docet search results 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. | |