org.osid.billing.payment

Interface PaymentSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface PaymentSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CustomerSearchOrder	getCustomerSearchOrder() Specifies a preference for ordering the result set by the customer.
PayerSearchOrder	getPayerSearchOrder() Specifies a preference for ordering the result set by the payer.
PaymentSearchOrderRecord	getPaymentSearchOrderRecord(Type paymentRecordType) Gets the payment search order record corresponding to the given payment record Type.
PeriodSearchOrder	getPeriodSearchOrder() Specifies a preference for ordering the result set by the billing period.
void	orderByAmount(SearchOrderStyle style) Specifies a preference for ordering the result set by the amount.
void	orderByCustomer(SearchOrderStyle style) Specifies a preference for ordering the result set by the customer.
void	orderByPayer(SearchOrderStyle style) Specifies a preference for ordering the result set by the payer.
void	orderByPaymentDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the payment date.
void	orderByPeriod(SearchOrderStyle style) Specifies a preference for ordering the result set by the billing period.
void	orderByProcessDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the process date.
boolean	supportsCustomerSearchOrder() Tests if a customer search order is available.
boolean	supportsPayerSearchOrder() Tests if a payer search order is available.
boolean	supportsPeriodSearchOrder() Tests if a billing period search order is available.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

orderByPayer

void orderByPayer(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsPayerSearchOrder

boolean supportsPayerSearchOrder()

Tests if a payer search order is available.

Returns:

true if a payer search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPayerSearchOrder

PayerSearchOrder getPayerSearchOrder()

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

Returns:

the payer search order

Throws:

UnimplementedException - supportsPayerSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsPayerSearchOrder() is 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 supportsCustomerSearchOrder() is true.

orderByPeriod

void orderByPeriod(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsPeriodSearchOrder

boolean supportsPeriodSearchOrder()

Tests if a billing period search order is available.

Returns:

true if a period search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPeriodSearchOrder

PeriodSearchOrder getPeriodSearchOrder()

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

Returns:

the period search order

Throws:

UnimplementedException - supportsPeriodSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsPeriodSearchOrder() is true.

orderByPaymentDate

void orderByPaymentDate(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByProcessDate

void orderByProcessDate(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByAmount

void orderByAmount(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getPaymentSearchOrderRecord

PaymentSearchOrderRecord getPaymentSearchOrderRecord(Type paymentRecordType)
                                                     throws OperationFailedException

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

Parameters:

paymentRecordType - a payment record type

Returns:

the payment search order record

Throws:

NullArgumentException - paymentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(paymentRecordType) is false

Compliance:

mandatory - This method must be implemented.