OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CourseEntrySearchSession
Implementsosid.course.chronicle.CourseEntryQuerySession
Description

This session provides methods for searching among CourseEntries. The search query is constructed using the CourseEntryQuery.

getCourseEntriesByQuery() is the basic search method and returns a list of CourseEntries. A more advanced search may be performed with getCourseEntriesBySearch(). It accepts a CourseEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCourseEntriesBySearch() returns a CourseEntrySearchResults that can be used to access the resulting CourseEntryList or be used to perform a search within the result set through CourseEntrySearch.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include course entries in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to courses in this course catalog

CourseEntries may have a query record indicated by their respective record types. The query record is accessed via the CourseEntryQuery.

MethodgetCourseEntrySearch
Description

Gets a course entry search.

Returnosid.course.chronicle.CourseEntrySearchthe course entry search
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntrySearchOrder
Description

Gets a course entry search order. The CourseEntrySearchOrder is supplied to a CourseEntrySearch to specify the ordering of results.

Returnosid.course.chronicle.CourseEntrySearchOrderthe course entry search order
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntriesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.course.chronicle.CourseEntryQuerycourseEntryQuerythe course entry query
osid.course.chronicle.CourseEntrySearchcourseEntrySearchthe course entry search
Returnosid.course.chronicle.CourseEntrySearchResultsthe course entry search results
ErrorsNULL_ARGUMENT courseEntryQuery or courseEntrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED courseEntryQuery or CourseEntrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntryQueryFromInspector
Description

Gets a course entry query from an inspector. The inspector is available from a CourseEntrySearchResults.

Parametersosid.course.chronicle.CourseEntryQueryInspectorcourseEntryQueryInspectora course entry query inspector
Returnosid.course.chronicle.CourseEntryQuerythe course entry query
ErrorsNULL_ARGUMENT courseEntryQueryInspector is null
UNSUPPORTED courseEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.