public interface ShipmentSearchOrder extends OsidObjectSearchOrder, OsidAggregateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
OrderSearchOrder |
getOrderSearchOrder()
Specifies a preference for ordering the result set by the order.
|
ShipmentSearchOrderRecord |
getShipmentSearchOrderRecord(Type shipmentRecordType)
Gets the shipment search order record corresponding to the given
shipment record
Type. |
ResourceSearchOrder |
getSourceSearchOrder()
Specifies a preference for ordering the result set by the source.
|
void |
orderByDate(SearchOrderStyle style)
Specifies a preference for ordering the result set by the shipment
date.
|
void |
orderByOrder(SearchOrderStyle style)
Specifies a preference for ordering the result set by the order.
|
void |
orderBySource(SearchOrderStyle style)
Specifies a preference for ordering the result set by the source.
|
boolean |
supportsOrderSearchOrder()
Tests if an order search order is available.
|
boolean |
supportsSourceSearchOrder()
Tests if a resource search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderBySource(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSourceSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getSourceSearchOrder()
UnimplementedException
-
supportsSourceSearchOrder()
is false
optional
- This method must be implemented if
supportsSourceSearchOrder()
is true.
void orderByOrder(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsOrderSearchOrder()
true
if an order search 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 orderByDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ShipmentSearchOrderRecord getShipmentSearchOrderRecord(Type shipmentRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.shipmentRecordType
- a shipment record typeNullArgumentException
- shipmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(shipmentRecordType)
is false
mandatory
- This method must be implemented.