OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.ProgramOfferingSearchSession
Implementsosid.course.program.ProgramOfferingQuerySession
Description

This session provides methods for searching among ProgramOffering objects. The search query is constructed using the ProgramOfferingQuery.

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

This session defines views that offer differing behaviors for searching.

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

Program offerings may have a query record indicated by their respective record types. The queryrecord is accessed via the ProgramOfferingQuery.

MethodgetProgramOfferingSearch
Description

Gets a program offering search.

Returnosid.course.program.ProgramOfferingSearchthe program offering search
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingSearchOrder
Description

Gets a program offering search order. The ProgramOfferingSearchOrder is supplied to a ProgramOfferingSearch to specify the ordering of results.

Returnosid.course.program.ProgramOfferingSearchOrderthe program offering search order
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsBySearch
Description

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

Parametersosid.course.program.ProgramOfferingQueryprogramOfferingQuerythe program offering query
osid.course.program.ProgramOfferingSearchprogramOfferingSearchthe program offering search
Returnosid.course.program.ProgramOfferingSearchResultsthe program offering search results
ErrorsNULL_ARGUMENT programOfferingQuery or programOfferingSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED programOfferingQuery or programOfferingSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingQueryFromInspector
Description

Gets a program offering query from an inspector. The inspector is available from a ProgramOfferingSearchResults.

Parametersosid.assessment.ItemQueryInspectorprogramOfferingQueryInspectora program offering query inspector
Returnosid.course.program.ProgramOfferingQuerythe program offering query
ErrorsNULL_ARGUMENT programOfferingQueryInspector is null
UNSUPPORTED programOfferingQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.