Interface | osid.course.chronicle.ProgramEntrySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getProgramEntries | ||
Description |
Gets the course list resulting from a search. | ||
Return | osid.course.chronicle.ProgramEntryList | the program entry list | |
Errors | ILLEGAL_STATE | the program entry list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntryQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.chronicle.ProgramEntryQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntrySearchResultsRecord | ||
Description |
Gets the program entry search results record
corresponding to the given program entry search record
| ||
Parameters | osid.type.Type | programEntrySearchRecordType | a program entry search record type |
Return | osid.course.chronicle.records.ProgramEntrySearchResultsRecord | the program entry search results record | |
Errors | NULL_ARGUMENT | programEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(programEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |