public interface PaymentQueryInspector extends OsidObjectQueryInspector
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.
Modifier and Type | Method and Description |
---|---|
CurrencyRangeTerm[] |
getAmountTerms()
Gets the amount query terms.
|
IdTerm[] |
getBusinessIdTerms()
Gets the business
Id query terms. |
BusinessQueryInspector[] |
getBusinessTerms()
Gets the business query terms.
|
IdTerm[] |
getCustomerIdTerms()
Gets the customer
Id query terms. |
CustomerQueryInspector[] |
getCustomerTerms()
Gets the customer query terms.
|
IdTerm[] |
getPayerIdTerms()
Gets the payer
Id query terms. |
PayerQueryInspector[] |
getPayerTerms()
Gets the payer query terms.
|
DateTimeRangeTerm[] |
getPaymentDateTerms()
Gets the payment date query terms.
|
PaymentQueryInspectorRecord |
getPaymentQueryInspectorRecord(Type paymentRecordType)
Gets the payment query inspector record corresponding to the given
Payment record Type. |
IdTerm[] |
getPeriodIdTerms()
Gets the period
Id query terms. |
PeriodQueryInspector[] |
getPeriodTerms()
Gets the period query terms.
|
DateTimeRangeTerm[] |
getProcessDateTerms()
Gets the process date query terms.
|
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms
getIdTerms
getRecordTypeTerms
getRecordTypes, hasRecordType
getAnyTerms, getKeywordTerms
IdTerm[] getPayerIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. PayerQueryInspector[] getPayerTerms()
mandatory
- This method must be implemented. IdTerm[] getCustomerIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. CustomerQueryInspector[] getCustomerTerms()
mandatory
- This method must be implemented. IdTerm[] getPeriodIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. PeriodQueryInspector[] getPeriodTerms()
mandatory
- This method must be implemented. DateTimeRangeTerm[] getPaymentDateTerms()
mandatory
- This method must be implemented. DateTimeRangeTerm[] getProcessDateTerms()
mandatory
- This method must be implemented. CurrencyRangeTerm[] getAmountTerms()
mandatory
- This method must be implemented. IdTerm[] getBusinessIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. BusinessQueryInspector[] getBusinessTerms()
mandatory
- This method must be implemented. PaymentQueryInspectorRecord getPaymentQueryInspectorRecord(Type paymentRecordType) throws OperationFailedException
Payment
record Type.
Multiple record
retrievals produce a nested OR
term.paymentRecordType
- a payment record typeNullArgumentException
- paymentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(paymentRecordType)
is false
mandatory
- This method must be implemented.