org.osid.billing

Interface EntrySearchOrder

All Superinterfaces:

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

public interface EntrySearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CustomerSearchOrder	getCustomerSearchOrder() Gets the customer order.
EntrySearchOrderRecord	getEntrySearchOrderRecord(Type entryRecordType) Gets the entry search order record corresponding to the given entry record Type.
ItemSearchOrder	getItemSearchOrder() Gets the item search order.
PeriodSearchOrder	getPeriodSearchOrder() Gets the billing period search order.
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 customer.
void	orderByDebit(SearchOrderStyle style) Specifies a preference for ordering the result set by the debit flag.
void	orderByItem(SearchOrderStyle style) Specifies a preference for ordering the result set by item.
void	orderByPeriod(SearchOrderStyle style) Specifies a preference for ordering the result set by billing period.
void	orderByQuantity(SearchOrderStyle style) Specifies a preference for ordering the result set by the quantity.
boolean	supportsCustomerSearchOrder() Tests if a customer search order is available.
boolean	supportsItemSearchOrder() Tests if an item search order is available.
boolean	supportsPeriodSearchOrder() Tests if a billing period search order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByCustomer

void orderByCustomer(SearchOrderStyle style)

Specifies a preference for ordering the result set by 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()

Gets the customer order.

Returns:

the customer search order

Throws:

UnimplementedException - supportsCustomerSearchOrder() is false

Compliance:

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

orderByItem

void orderByItem(SearchOrderStyle style)

Specifies a preference for ordering the result set by item.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsItemSearchOrder

boolean supportsItemSearchOrder()

Tests if an item search order is available.

Returns:

true if an item search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getItemSearchOrder

ItemSearchOrder getItemSearchOrder()

Gets the item search order.

Returns:

the item search order

Throws:

UnimplementedException - supportsItemSearchOrder() is false

Compliance:

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

orderByPeriod

void orderByPeriod(SearchOrderStyle style)

Specifies a preference for ordering the result set by 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 term search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPeriodSearchOrder

PeriodSearchOrder getPeriodSearchOrder()

Gets the billing period search order.

Returns:

the period search order

Throws:

UnimplementedException - supportsPeriodSearchOrder() is false

Compliance:

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

orderByQuantity

void orderByQuantity(SearchOrderStyle style)

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

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.

orderByDebit

void orderByDebit(SearchOrderStyle style)

Specifies a preference for ordering the result set by the debit flag.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getEntrySearchOrderRecord

EntrySearchOrderRecord getEntrySearchOrderRecord(Type entryRecordType)
                                                 throws OperationFailedException

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

Parameters:

entryRecordType - an entry record type

Returns:

the entry search order record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.