Interface PayerSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface PayerSearchOrder extends OsidObjectSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByResource

      void orderByResource(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the resource.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceSearchOrder

      boolean supportsResourceSearchOrder()
      Tests if a resource search order is available.
      Returns:
      true if a resource search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getResourceSearchOrder

      ResourceSearchOrder getResourceSearchOrder()
      Specifies a preference for ordering the result set by the resource.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsResourceSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResourceSearchOrder()} is {@code true} .

    • orderByCustomer

      void orderByCustomer(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the customer.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerSearchOrder

      boolean supportsCustomerSearchOrder()
      Tests if a customer search order is available.
      Returns:
      true if a customer search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerSearchOrder

      CustomerSearchOrder getCustomerSearchOrder()
      Specifies a preference for ordering the result set by the customer.
      Returns:
      the customer search order
      Throws:
      UnimplementedException - supportsCustomerSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCustomerSearchOrder()} is {@code true} .

    • orderByUsesActivity

      void orderByUsesActivity(SearchOrderStyle style)
      Specifies a preference for ordering the result set by activity based customers.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByUsesCash

      void orderByUsesCash(SearchOrderStyle style)
      Specifies a preference for ordering the result set by cash customers.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreditCardNumber

      void orderByCreditCardNumber(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the credit card number.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreditCardExpiration

      void orderByCreditCardExpiration(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the credit card expiration.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreditCardCode

      void orderByCreditCardCode(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the credit card code.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByBankRoutingNumber

      void orderByBankRoutingNumber(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the bank routing number.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByBankAccountNumber

      void orderByBankAccountNumber(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the bank account number.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getPayerSearchOrderRecord

      PayerSearchOrderRecord getPayerSearchOrderRecord(Type payerRecordType) throws OperationFailedException
      Gets the payer search order record corresponding to the given payer record Type . Multiple retrievals return the same underlying object.
      Parameters:
      payerRecordType - a payer record type
      Returns:
      the payer search order record
      Throws:
      NullArgumentException - payerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(payerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.