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

An interface for specifying the ordering of search results.

MethodorderByPayer
Description

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

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

Tests if a payer search order is available.

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

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

Returnosid.billing.payment.PayerSearchOrderthe payer search order
ErrorsUNIMPLEMENTED supportsPayerSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsPayerSearchOrder() 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.
MethodorderByPeriod
Description

Specifies a preference for ordering the result set by the billing period.

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

Tests if a billing period search order is available.

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

Specifies a preference for ordering the result set by the billing period.

Returnosid.billing.PeriodSearchOrderthe period search order
ErrorsUNIMPLEMENTED supportsPeriodSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsPeriodSearchOrder() is true.
MethodorderByPaymentDate
Description

Specifies a preference for ordering the result set by the payment date.

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

Specifies a preference for ordering the result set by the process date.

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

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

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

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

Parametersosid.type.TypepaymentRecordTypea payment record type
Returnosid.billing.payment.records.PaymentSearchOrderRecordthe payment search order record
ErrorsNULL_ARGUMENT paymentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(paymentRecordType) is false
CompliancemandatoryThis method must be implemented.