OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.EnrollmentQueryInspector
Implementsosid.OsidRelationshipQueryInspector
Description

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

MethodgetProgramOfferingIdTerms
Description

Gets the program offering Id query terms.

Returnosid.search.terms.IdTerm[]the program offering Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingTerms
Description

Gets the program offering query terms.

Returnosid.course.program.ProgramOfferingQueryInspector[]the program offering query terms
CompliancemandatoryThis method must be implemented.
MethodgetStudentIdTerms
Description

Gets the student Id query terms.

Returnosid.search.terms.IdTerm[]the resource Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetStudentTerms
Description

Gets the student query terms.

Returnosid.resource.ResourceQueryInspector[]the student query terms
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdTerms
Description

Gets the course catalog Id query terms.

Returnosid.search.terms.IdTerm[]the course catalog Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogTerms
Description

Gets the course catalog query terms.

Returnosid.course.CourseCatalogQueryInspector[]the course catalog query terms
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentQueryInspectorRecord
Description

Gets the enrollment query inspector record corresponding to the given Enrollment record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeenrollmentRecordTypean enrollment record type
Returnosid.course.program.records.EnrollmentQueryInspectorRecordthe enrollment query inspector record
ErrorsNULL_ARGUMENT enrollmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(enrollmentRecordType) is false
CompliancemandatoryThis method must be implemented.