Interface | osid.course.chronicle.CourseEntrySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing course entry searches. | ||
Method | searchAmongCourseEntries | ||
Description |
Execute this search among the given list of course entries. | ||
Parameters | osid.id.IdList | courseEntryIds | list of course entry Ids |
Errors | NULL_ARGUMENT | courseEntryIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderCourseEntryResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.course.chronicle.CourseEntrySearchOrder | courseEntrySearchOrder | course entry search order |
Errors | NULL_ARGUMENT | courseEntrySearchOrder is null | |
UNSUPPORTED | courseEntrySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntrySearchRecord | ||
Description |
Gets the course entry search record corresponding to
the given course entry search record | ||
Parameters | osid.type.Type | courseEntrySearchRecordType | a course entry search record type |
Return | osid.course.chronicle.records.CourseEntrySearchRecord | the course entry search record | |
Errors | NULL_ARGUMENT | courseEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(courseEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |