OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.ProgramEntrySearchSession
Implementsosid.course.chronicle.ProgramEntryQuerySession
Description

This session provides methods for searching among ProgramEntries. The search query is constructed using the ProgramEntryQuery.

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

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include program 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

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

MethodgetProgramEntrySearch
Description

Gets a program entry search.

Returnosid.course.chronicle.ProgramEntrySearchthe program entry search
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntrySearchOrder
Description

Gets a program entry search order. The ProgramEntrySearchOrder is supplied to a ProgramEntrySearch to specify the ordering of results.

Returnosid.course.chronicle.ProgramEntrySearchOrderthe program entry search order
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesBySearch
Description

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

Parametersosid.course.chronicle.ProgramEntryQueryprogramEntryQuerythe program entry query
osid.course.chronicle.ProgramEntrySearchprogramEntrySearchthe program entry search
Returnosid.course.chronicle.ProgramEntrySearchResultsthe program entry search results
ErrorsNULL_ARGUMENT programEntryQuery or programEntrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED programEntryQuery or ProgramEntrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntryQueryFromInspector
Description

Gets a program entry query from an inspector. The inspector is available from a ProgramEntrySearchResults.

Parametersosid.course.chronicle.ProgramEntryQueryInspectorprogramEntryQueryInspectora program entry query inspector
Returnosid.course.chronicle.ProgramEntryQuerythe program entry query
ErrorsNULL_ARGUMENT programEntryQueryInspector is null
UNSUPPORTED programEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.