OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationQueryInspector
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.

MethodgetActivityBundleIdTerms
Description

Gets the activity bundle Id query terms.

Returnosid.search.terms.IdTerm[]the activity bundle Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetActivityBundleTerms
Description

Gets the activity bundle query terms.

Returnosid.course.registration.ActivityBundleQueryInspector[]the activity bundle query terms
CompliancemandatoryThis method must be implemented.
MethodgetStudentIdTerms
Description

Gets the student Id query terms.

Returnosid.search.terms.IdTerm[]the student 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.
MethodgetCreditsTerms
Description

Gets the credits query terms.

Returnosid.search.terms.DecimalTerm[]the credits query terms
CompliancemandatoryThis method must be implemented.
MethodgetGradingOptionIdTerms
Description

Gets the grade system Id query terms.

Returnosid.search.terms.IdTerm[]the grade system Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetGradingOptionTerms
Description

Gets the grade system query terms.

Returnosid.grading.GradeSystemQueryInspector[]the grade system 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.
MethodgetRegistrationQueryInspectorRecord
Description

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

Parametersosid.type.TyperegistrationRecordTypea registration record type
Returnosid.course.registration.records.RegistrationQueryInspectorRecordthe registration query inspector record
ErrorsNULL_ARGUMENT registrationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(registrationRecordType) is false
CompliancemandatoryThis method must be implemented.