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

MethodgetRegistrationIdTerms
Description

Gets the registration Id query terms.

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

Gets the registration query terms.

Returnosid.course.registration.RegistrationQueryInspector[]the registration query terms
CompliancemandatoryThis method must be implemented.
MethodgetActivityIdTerms
Description

Gets the activity Id query terms.

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

Gets the activity query terms.

Returnosid.course.ActivityQueryInspector[]the activity 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.
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.
MethodgetActivityRegistrationQueryInspectorRecord
Description

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

Parametersosid.type.TypeactivityRegistrationRecordTypean activity registration record type
Returnosid.course.registration.records.ActivityRegistrationQueryInspectorRecordthe activity registration query inspector record
ErrorsNULL_ARGUMENT activityRegistrationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRegistrationRecordType) is false
CompliancemandatoryThis method must be implemented.