Interface PaymentQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
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.

  • Method Details

    • getPayerIdTerms

      IdTerm[] getPayerIdTerms()
      Gets the payer Id query terms.
      Returns:
      the payer Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPayerTerms

      PayerQueryInspector[] getPayerTerms()
      Gets the payer query terms.
      Returns:
      the payer 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.

    • getPeriodIdTerms

      IdTerm[] getPeriodIdTerms()
      Gets the period Id query terms.
      Returns:
      the period Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPeriodTerms

      PeriodQueryInspector[] getPeriodTerms()
      Gets the period query terms.
      Returns:
      the period query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPaymentDateTerms

      DateTimeRangeTerm[] getPaymentDateTerms()
      Gets the payment date query terms.
      Returns:
      the payment date query terms
      Compliance:
      mandatory - This method must be implemented.

    • getProcessDateTerms

      DateTimeRangeTerm[] getProcessDateTerms()
      Gets the process date query terms.
      Returns:
      the process date query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAmountTerms

      CurrencyRangeTerm[] getAmountTerms()
      Gets the amount query terms.
      Returns:
      the amount query 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.

    • getBusinessTerms

      BusinessQueryInspector[] getBusinessTerms()
      Gets the business query terms.
      Returns:
      the business query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPaymentQueryInspectorRecord

      PaymentQueryInspectorRecord getPaymentQueryInspectorRecord(Type paymentRecordType) throws OperationFailedException
      Gets the payment query inspector record corresponding to the given Payment record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      paymentRecordType - a payment record type
      Returns:
      the payment query inspector record
      Throws:
      NullArgumentException - paymentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(paymentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.