public interface ItemSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ItemSearchOrderRecord |
getItemSearchOrderRecord(Type itemRecordType)
Gets the item search record order corresponding to the given item
record Type.
|
OrderSearchOrder |
getOrderSearchOrder()
Gets the order order.
|
ProductSearchOrder |
getProductSearchOrder()
Gets the product order.
|
void |
orderByDerived(SearchOrderStyle style)
Specifies a preference for ordering the result set by the derived
flag.
|
void |
orderByOrder(SearchOrderStyle style)
Specifies a preference for ordering the result set by the order.
|
void |
orderByProduct(SearchOrderStyle style)
Specifies a preference for ordering the result set by the product.
|
void |
orderByQuantity(SearchOrderStyle style)
Specifies a preference for ordering the result set by the quantity.
|
boolean |
supportsOrderSearchOrder()
Tests if an order order is available.
|
boolean |
supportsProductSearchOrder()
Tests if a product order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByOrder(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsOrderSearchOrder()
true
if an order order is available,
false
otherwisemandatory
- This method must be implemented. OrderSearchOrder getOrderSearchOrder()
UnimplementedException
-
supportsOrderSearchOrder()
is false
optional
- This method must be implemented if
supportsOrderSearchOrder()
is true.
void orderByDerived(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByProduct(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsProductSearchOrder()
true
if a product order is available,
false
otherwisemandatory
- This method must be implemented. ProductSearchOrder getProductSearchOrder()
UnimplementedException
-
supportsProductSearchOrder()
is false
optional
- This method must be implemented if
supportsProductSearchOrder()
is true.
void orderByQuantity(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ItemSearchOrderRecord getItemSearchOrderRecord(Type itemRecordType) throws OperationFailedException
itemRecordType
- an item record typeNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemRecordType)
is false
mandatory
- This method must be implemented.