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

MethodgetCreditIdTerms
Description

Gets the credit Id query terms.

Returnosid.search.terms.IdTerm[]the credit Id terms
CompliancemandatoryThis method must be implemented.
MethodgetCreditTerms
Description

Gets the credit query terms.

Returnosid.acknowledgement.CreditQueryInspector[]the credit terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorBillingIdTerms
Description

Gets the ancestor billing Id query terms.

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

Gets the ancestor billing query terms.

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

Gets the descendant billing Id query terms.

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

Gets the descendant billing query terms.

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

Gets the record query inspector record corresponding to the given Billing record Type.

Parametersosid.type.TypebillingRecordTypea billing record type
Returnosid.acknowledgement.records.BillingQueryInspectorRecordthe billing query inspector record
ErrorsNULL_ARGUMENT billingRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(billingRecordType) is false
CompliancemandatoryThis method must be implemented.