Interface | osid.course.syllabus.SyllabusSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getSyllabi | ||
Description |
Gets the syllabus list resulting from a search. | ||
Return | osid.course.syllabus.SyllabusList | the syllabus list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabusQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.course.syllabus.SyllabusQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabusSearchResultsRecord | ||
Description |
Gets the syllabus search results record corresponding
to the given syllabus search record | ||
Parameters | osid.type.Type | syllabusSearchRecordType | a syllabus search record type |
Return | osid.course.syllabus.records.SyllabusSearchResultsRecord | the syllabus search record | |
Errors | NULL_ARGUMENT | syllabusSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(syllabusSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |