org.osid.billing.payment

Interface PayerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidTemporalQueryInspector

public interface PayerQueryInspector
extends OsidObjectQueryInspector, OsidTemporalQueryInspector

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.

Method Summary

Methods

Modifier and Type	Method and Description
StringTerm[]	getBankAccountNumberTerms() Gets the bank account number terms.
StringTerm[]	getBankRoutingNumberTerms() Gets the bank routing number terms.
IdTerm[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
StringTerm[]	getCreditCardCodeTerms() Gets the credit card code terms.
DateTimeRangeTerm[]	getCreditCardExpirationTerms() Gets the credit card expiration terms.
StringTerm[]	getCreditCardNumberTerms() Gets the credit card number terms.
IdTerm[]	getCustomerIdTerms() Gets the customer Id query terms.
CustomerQueryInspector[]	getCustomerTerms() Gets the customer query terms.
PayerQueryInspectorRecord	getPayerQueryInspectorRecord(Type payerRecordType) Gets the payer query inspector record corresponding to the given Payer record Type.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.
BooleanTerm[]	getUsesActivityTerms() Gets the activity terms.
BooleanTerm[]	getUsesCashTerms() Gets the cash terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the resource Id query terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the resource query terms

Compliance:

mandatory - This method must be implemented.

getCustomerIdTerms

IdTerm[] getCustomerIdTerms()

Gets the customer Id query terms.

Returns:

the customer Id query terms

Compliance:

mandatory - This method must be implemented.

getCustomerTerms

CustomerQueryInspector[] getCustomerTerms()

Gets the customer query terms.

Returns:

the customer query terms

Compliance:

mandatory - This method must be implemented.

getUsesActivityTerms

BooleanTerm[] getUsesActivityTerms()

Gets the activity terms.

Returns:

the activity terms

Compliance:

mandatory - This method must be implemented.

getUsesCashTerms

BooleanTerm[] getUsesCashTerms()

Gets the cash terms.

Returns:

the cash terms

Compliance:

mandatory - This method must be implemented.

getCreditCardNumberTerms

StringTerm[] getCreditCardNumberTerms()

Gets the credit card number terms.

Returns:

the credit card number terms

Compliance:

mandatory - This method must be implemented.

getCreditCardExpirationTerms

DateTimeRangeTerm[] getCreditCardExpirationTerms()

Gets the credit card expiration terms.

Returns:

the credit card expiration terms

Compliance:

mandatory - This method must be implemented.

getCreditCardCodeTerms

StringTerm[] getCreditCardCodeTerms()

Gets the credit card code terms.

Returns:

the credit card code terms

Compliance:

mandatory - This method must be implemented.

getBusinessIdTerms

IdTerm[] getBusinessIdTerms()

Gets the business Id query terms.

Returns:

the business Id query terms

Compliance:

mandatory - This method must be implemented.

getBankRoutingNumberTerms

StringTerm[] getBankRoutingNumberTerms()

Gets the bank routing number terms.

Returns:

the bank routing number terms

Compliance:

mandatory - This method must be implemented.

getBankAccountNumberTerms

StringTerm[] getBankAccountNumberTerms()

Gets the bank account number terms.

Returns:

the bank account number terms

Compliance:

mandatory - This method must be implemented.

getBusinessTerms

BusinessQueryInspector[] getBusinessTerms()

Gets the business query terms.

Returns:

the business query terms

Compliance:

mandatory - This method must be implemented.

getPayerQueryInspectorRecord

PayerQueryInspectorRecord getPayerQueryInspectorRecord(Type payerRecordType)
                                                       throws OperationFailedException

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

Parameters:

payerRecordType - a payer record type

Returns:

the payer query inspector record

Throws:

NullArgumentException - payerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(payerRecordType) is false

Compliance:

mandatory - This method must be implemented.