public interface EntrySearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
EntrySearchOrderRecord |
getEntrySearchOrderRecord(Type entryRecordType)
Gets the entry search order record corresponding to the given entry
record
Type. |
ItemSearchOrder |
getItemSearchOrder()
Gets the item search order.
|
ModelSearchOrder |
getModelSearchOrder()
Gets the model search order.
|
StockSearchOrder |
getStockSearchOrder()
Gets the shipment order.
|
void |
orderByItem(SearchOrderStyle style)
Specifies a preference for ordering the result set by the item.
|
void |
orderByModel(SearchOrderStyle style)
Specifies a preference for ordering the result set by the model.
|
void |
orderByQuantity(SearchOrderStyle style)
Specifies a preference for ordering the result set by quantity.
|
void |
orderByStock(SearchOrderStyle style)
Specifies a preference for ordering the result set by stock.
|
void |
orderByUnitType(SearchOrderStyle style)
Specifies a preference for ordering the result set by the unit type.
|
boolean |
supportsItemSearchOrder()
Tests if an item search order is available.
|
boolean |
supportsModelSearchOrder()
Tests if a model search order is available.
|
boolean |
supportsStockSearchOrder()
Tests if a stock search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByStock(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsStockSearchOrder()
true
if a stock search order is available,
false
otherwisemandatory
- This method must be implemented. StockSearchOrder getStockSearchOrder()
UnimplementedException
-
supportsStockSearchOrder()
is false
optional
- This method must be implemented if
supportsStockSearchOrder()
is true.
void orderByModel(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsModelSearchOrder()
true
if a model search order is available,
false
otherwisemandatory
- This method must be implemented. ModelSearchOrder getModelSearchOrder()
UnimplementedException
-
supportsModelSearchOrder()
is false
optional
- This method must be implemented if
supportsModelSearchOrder()
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 orderByQuantity(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByUnitType(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.