OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.TermQueryInspector
Implementsosid.OsidObjectQueryInspector
osid.OsidFederateableQueryInspector
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.

MethodgetDisplayLabelTerms
Description

Gets the display label query terms.

Returnosid.search.terms.StringTerm[]the display labelquery terms
CompliancemandatoryThis method must be implemented.
MethodgetOpenDateTerms
Description

Gets the open date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the open date query terms
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationStartTerms
Description

Gets the registration start date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the registration start date query terms
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationEndTerms
Description

Gets the registration end date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the registration end date query terms
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationPeriodTerms
Description

Gets the registration period query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the registration period query terms
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationDurationTerms
Description

Gets the registration duration query terms.

Returnosid.search.terms.DurationRangeTerm[]the registration duration query terms
CompliancemandatoryThis method must be implemented.
MethodgetClassesStartTerms
Description

Gets the class start date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the class start date query terms
CompliancemandatoryThis method must be implemented.
MethodgetClassesEndTerms
Description

Gets the class end date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the class end date query terms
CompliancemandatoryThis method must be implemented.
MethodgetClassesPeriodTerms
Description

Gets the class period query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the class period query terms
CompliancemandatoryThis method must be implemented.
MethodgetClassesDurationTerms
Description

Gets the classes duration query terms.

Returnosid.search.terms.DurationRangeTerm[]the classes duration query terms
CompliancemandatoryThis method must be implemented.
MethodgetAddDateTerms
Description

Gets the add date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the add date query terms
CompliancemandatoryThis method must be implemented.
MethodgetDropDateTerms
Description

Gets the drop date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the drop date query terms
CompliancemandatoryThis method must be implemented.
MethodgetFinalExamStartTerms
Description

Gets the final exam start date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the final exam start date query terms
CompliancemandatoryThis method must be implemented.
MethodgetFinalExamEndTerms
Description

Gets the final exam end date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the final exam end date query terms
CompliancemandatoryThis method must be implemented.
MethodgetFinalExamPeriodTerms
Description

Gets the final exam period query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the final exam period query terms
CompliancemandatoryThis method must be implemented.
MethodgetFinalExamDurationTerms
Description

Gets the final exam duration query terms.

Returnosid.search.terms.DurationRangeTerm[]the final exam duration query terms
CompliancemandatoryThis method must be implemented.
MethodgetCloseDateTerms
Description

Gets the close date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the close date query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorTermIdTerms
Description

Gets the ancestor term Id query terms.

Returnosid.search.terms.IdTerm[]the ancestor term Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorTermTerms
Description

Gets the ancestor term query terms.

Returnosid.course.TermQueryInspector[]the ancestor term terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantTermIdTerms
Description

Gets the descendant term Id query terms.

Returnosid.search.terms.IdTerm[]the descendant term Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantTermTerms
Description

Gets the descendant term query terms.

Returnosid.course.TermQueryInspector[]the descendant term terms
CompliancemandatoryThis method must be implemented.
MethodgetCourseOfferingIdTerms
Description

Gets the course offering Id query terms.

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

Gets the course offering query terms.

Returnosid.course.CourseOfferingQueryInspector[]the course offering 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.
MethodgetTermQueryInspectorRecord
Description

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

Parametersosid.type.TypetermRecordTypea term record type
Returnosid.course.records.TermQueryInspectorRecordthe term query inspector record
ErrorsNULL_ARGUMENT termRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(termRecordType) is false
CompliancemandatoryThis method must be implemented.