public interface EntrySearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
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.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByCustomer(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCustomerSearchOrder()
true
if a customer search order is available,
false
otherwisemandatory
- This method must be implemented. CustomerSearchOrder getCustomerSearchOrder()
UnimplementedException
-
supportsCustomerSearchOrder()
is false
optional
- This method must be implemented if
supportsCustomerSearchOrder()
is true.
void orderByItem(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsItemSearchOrder()
true
if an item search order is available,
false
otherwisemandatory
- This method must be implemented. ItemSearchOrder getItemSearchOrder()
UnimplementedException
-
supportsItemSearchOrder()
is false
optional
- This method must be implemented if
supportsItemSearchOrder()
is true.
void orderByPeriod(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPeriodSearchOrder()
true
if a term search order is available,
false
otherwisemandatory
- This method must be implemented. PeriodSearchOrder getPeriodSearchOrder()
UnimplementedException
-
supportsPeriodSearchOrder()
is false
optional
- This method must be implemented if
supportsPeriodSearchOrder()
is true.
void orderByQuantity(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByAmount(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDebit(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. EntrySearchOrderRecord getEntrySearchOrderRecord(Type entryRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.entryRecordType
- an entry record typeNullArgumentException
- entryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(entryRecordType)
is false
mandatory
- This method must be implemented.