Interface | osid.course.chronicle.CourseEntrySearchSession | ||
---|---|---|---|
Implements | osid.course.chronicle.CourseEntryQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
CourseEntries may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCourseEntrySearch | ||
Description |
Gets a course entry search. | ||
Return | osid.course.chronicle.CourseEntrySearch | the course entry search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntrySearchOrder | ||
Description |
Gets a course entry search order. The | ||
Return | osid.course.chronicle.CourseEntrySearchOrder | the course entry search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntriesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.course.chronicle.CourseEntryQuery | courseEntryQuery | the course entry query |
osid.course.chronicle.CourseEntrySearch | courseEntrySearch | the course entry search | |
Return | osid.course.chronicle.CourseEntrySearchResults | the course entry search results | |
Errors | NULL_ARGUMENT | courseEntryQuery or courseEntrySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | courseEntryQuery or CourseEntrySearch is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntryQueryFromInspector | ||
Description |
Gets a course entry query from an inspector. The
inspector is available from a | ||
Parameters | osid.course.chronicle.CourseEntryQueryInspector | courseEntryQueryInspector | a course entry query inspector |
Return | osid.course.chronicle.CourseEntryQuery | the course entry query | |
Errors | NULL_ARGUMENT | courseEntryQueryInspector is null | |
UNSUPPORTED | courseEntryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |