OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.ResultQueryInspector
Implementsosid.OsidObjectQueryInspector
osid.OsidTemporalQueryInspector
osid.OsidSubjugateableQueryInspector
Used Byosid.offering.CatalogueQueryInspector
osid.offering.ResultSearchResults
osid.offering.ResultSmartCatalogueSession
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.

MethodgetParticipantIdTerms
Description

Gets the participant Id query terms.

Returnosid.search.terms.IdTerm[] the participant Id terms
Compliancemandatory This method must be implemented.
MethodgetParticipantTerms
Description

Gets the participant query terms.

Returnosid.offering.ParticipantQueryInspector[] the participant terms
Compliancemandatory This method must be implemented.
MethodgetGradeIdTerms
Description

Gets the grade Id query terms.

Returnosid.search.terms.IdTerm[] the grade Id terms
Compliancemandatory This method must be implemented.
MethodgetGradeTerms
Description

Gets the grade query terms.

Returnosid.grading.GradeQueryInspector[] the grade terms
Compliancemandatory This method must be implemented.
MethodgetValueTerms
Description

Gets the value query terms.

Returnosid.search.terms.DecimalRangeTerm[] the value terms
Compliancemandatory This method must be implemented.
MethodgetCatalogueIdTerms
Description

Gets the catalogue Id query terms.

Returnosid.search.terms.IdTerm[] the catalogue Id terms
Compliancemandatory This method must be implemented.
MethodgetCatalogueTerms
Description

Gets the catalogue query terms.

Returnosid.offering.CatalogueQueryInspector[] the catalogue terms
Compliancemandatory This method must be implemented.
MethodgetResultQueryInspectorRecord
Description

Gets the result query inspector record corresponding to the given Result record Type.

Parametersosid.type.TyperesultRecordType a result record type
Returnosid.offering.records.ResultQueryInspectorRecord the result inspector query record
ErrorsNULL_ARGUMENT resultRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(resultRecordType) is false
Compliancemandatory This method must be implemented.