OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.PayerSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidTemporalSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

Specifies a preference for ordering the result set by the resource.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResourceSearchOrder
Description

Specifies a preference for ordering the result set by the resource.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsResourceSearchOrder() is true.
MethodorderByCustomer
Description

Specifies a preference for ordering the result set by the customer.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCustomerSearchOrder
Description

Tests if a customer search order is available.

Returnboolean true if a customer search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCustomerSearchOrder
Description

Specifies a preference for ordering the result set by the customer.

Returnosid.billing.CustomerSearchOrderthe customer search order
ErrorsUNIMPLEMENTED supportsCustomerSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCustomerSearchOrder() is true.
MethodorderByUsesActivity
Description

Specifies a preference for ordering the result set by activity based customers.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByUsesCash
Description

Specifies a preference for ordering the result set by cash customers.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCreditCardNumber
Description

Specifies a preference for ordering the result set by the credit card number.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCreditCardExpiration
Description

Specifies a preference for ordering the result set by the credit card expiration.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCreditCardCode
Description

Specifies a preference for ordering the result set by the credit card code.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByBankRoutingNumber
Description

Specifies a preference for ordering the result set by the bank routing number.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByBankAccountNumber
Description

Specifies a preference for ordering the result set by the bank account number.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetPayerSearchOrderRecord
Description

Gets the payer search order record corresponding to the given payer record Type. Multiple retrievals return the same underlying object.

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