OSID Logo
OSID Specifications
acknowledgement package
Version 3.1.0
Interfaceosid.acknowledgement.CreditQueryInspector
Implementsosid.OsidRelationshipQueryInspector
Used Byosid.OsidObjectQueryInspector
osid.acknowledgement.BillingQueryInspector
osid.acknowledgement.CreditSearchResults
osid.acknowledgement.CreditSmartBillingSession
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.

Like all OsidQueryInspectors, CreditQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetReferenceIdTerms
Description

Gets the reference Id query terms.

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

Gets the resource Id query terms.

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

Gets the resource query terms.

Returnosid.resource.ResourceQueryInspector[] the resource terms
Compliancemandatory This method must be implemented.
MethodgetBillingIdTerms
Description

Gets the billing Id query terms.

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

Gets the billing query terms.

Returnosid.acknowledgement.BillingQueryInspector[] the billing terms
Compliancemandatory This method must be implemented.
MethodgetCreditQueryInspectorRecord
Description

Gets the credit query inspector record corresponding to the given Credit record Type.

Parametersosid.type.TypecreditRecordType a credit record type
Returnosid.acknowledgement.records.CreditQueryInspectorRecord the credit inspector query record
ErrorsNULL_ARGUMENT creditRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(creditRecordType) is false
Compliancemandatory This method must be implemented.