OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.PayerQueryInspector
Implementsosid.OsidObjectQueryInspector
osid.OsidTemporalQueryInspector
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.

MethodgetResourceIdTerms
Description

Gets the resource Id query terms.

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

Gets the resource query terms.

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

Gets the customer Id query terms.

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

Gets the customer query terms.

Returnosid.billing.CustomerQueryInspector[]the customer query terms
CompliancemandatoryThis method must be implemented.
MethodgetUsesActivityTerms
Description

Gets the activity terms.

Returnosid.search.terms.BooleanTerm[]the activity terms
CompliancemandatoryThis method must be implemented.
MethodgetUsesCashTerms
Description

Gets the cash terms.

Returnosid.search.terms.BooleanTerm[]the cash terms
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardNumberTerms
Description

Gets the credit card number terms.

Returnosid.search.terms.StringTerm[]the credit card number terms
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardExpirationTerms
Description

Gets the credit card expiration terms.

Returnosid.search.terms.DateTimeRangeTerm[]the credit card expiration terms
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardCodeTerms
Description

Gets the credit card code terms.

Returnosid.search.terms.StringTerm[]the credit card code terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdTerms
Description

Gets the business Id query terms.

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

Gets the bank routing number terms.

Returnosid.search.terms.StringTerm[]the bank routing number terms
CompliancemandatoryThis method must be implemented.
MethodgetBankAccountNumberTerms
Description

Gets the bank account number terms.

Returnosid.search.terms.StringTerm[]the bank account number terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessTerms
Description

Gets the business query terms.

Returnosid.billing.BusinessQueryInspector[]the business query terms
CompliancemandatoryThis method must be implemented.
MethodgetPayerQueryInspectorRecord
Description

Gets the payer query inspector record corresponding to the given Payer record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypepayerRecordTypea payer record type
Returnosid.billing.payment.records.PayerQueryInspectorRecordthe payer query inspector record
ErrorsNULL_ARGUMENT payerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(payerRecordType) is false
CompliancemandatoryThis method must be implemented.