OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.OfferingQueryInspector
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.

MethodgetCanonicalUnitIdTerms
Description

Gets the canonical unit Id query terms.

Returnosid.search.terms.IdTerm[]the canonical unit Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitTerms
Description

Gets the canonical unit query terms.

Returnosid.offering.CanonicalUnitQueryInspector[]the canonical unit query terms
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodIdTerms
Description

Gets the time period Id query terms.

Returnosid.search.terms.IdTerm[]the time period Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodTerms
Description

Gets the time period query terms.

Returnosid.calendaring.TimePeriodQueryInspector[]the time period query terms
CompliancemandatoryThis method must be implemented.
MethodgetTitleTerms
Description

Gets the title query terms.

Returnosid.search.terms.StringTerm[]the title terms
CompliancemandatoryThis method must be implemented.
MethodgetCodeTerms
Description

Gets the code query terms.

Returnosid.search.terms.StringTerm[]the code terms
CompliancemandatoryThis method must be implemented.
MethodgetResultOptionIdTerms
Description

Gets the grade system Id query terms.

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

Gets the grade system query terms.

Returnosid.grading.GradeSystemQueryInspector[]the grade system terms
CompliancemandatoryThis method must be implemented.
MethodgetSponsorIdTerms
Description

Gets the sponsor Id query terms.

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

Gets the sponsor query terms.

Returnosid.resource.ResourceQueryInspector[]the sponsor query terms
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueIdTerms
Description

Gets the catalogue Id query terms.

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

Gets the catalogue query terms.

Returnosid.offering.CatalogueQueryInspector[]the catalogue terms
CompliancemandatoryThis method must be implemented.
MethodgetOfferingQueryInspectorRecord
Description

Gets the offering query inspector record corresponding to the given Offering record Type.

Parametersosid.type.TypeofferingRecordTypean offering record type
Returnosid.offering.records.OfferingQueryInspectorRecordthe offering inspector query record
ErrorsNULL_ARGUMENT offeringRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringRecordType) is false
CompliancemandatoryThis method must be implemented.