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

MethodgetReferenceIdTerms
Description

Gets the reference Id query terms.

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

Gets the resource Id query terms.

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

Gets the resource query terms.

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

Gets the billing Id query terms.

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

Gets the billing query terms.

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

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

Parametersosid.type.TypecreditRecordTypea credit record type
Returnosid.acknowledgement.records.CreditQueryInspectorRecordthe credit inspector query record
ErrorsNULL_ARGUMENT creditRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(creditRecordType) is false
CompliancemandatoryThis method must be implemented.