public interface ItemSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ItemSearchOrder |
getItemSearchOrder()
Gets the item order for a stock.
|
ItemSearchOrderRecord |
getItemSearchOrderRecord(Type itemRecordType)
Gets the item search order record corresponding to the given item
record
Type. |
LocationSearchOrder |
getLocationSearchOrder()
Gets the location order for a stock.
|
StockSearchOrder |
getStockSearchOrder()
Gets the search order for a stock.
|
void |
orderByItem(SearchOrderStyle style)
Specifies a preference for ordering the result set by the containing
item.
|
void |
orderByLocation(SearchOrderStyle style)
Specifies a preference for ordering the result set by the location.
|
void |
orderByLocationDescription(SearchOrderStyle style)
Specifies a preference for ordering the result set by the location
description.
|
void |
orderByPropertyTag(SearchOrderStyle style)
Specifies a preference for ordering the result set by the property
tag.
|
void |
orderBySerialNumber(SearchOrderStyle style)
Specifies a preference for ordering the result set by the serial
number.
|
void |
orderByStock(SearchOrderStyle style)
Specifies a preference for ordering the result set by the stock.
|
boolean |
supportsItemSearchOrder()
Tests if an
ItemSearchOrder is available. |
boolean |
supportsLocationSearchOrder()
Tests if a
LocationSearchOrder is available. |
boolean |
supportsStockSearchOrder()
Tests if a
StockSearchOrder 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()
StockSearchOrder
is available. 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 orderByPropertyTag(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySerialNumber(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByLocationDescription(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByLocation(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsLocationSearchOrder()
LocationSearchOrder
is available. true
if a location search order is available,
false
otherwisemandatory
- This method must be implemented. LocationSearchOrder getLocationSearchOrder()
UnimplementedException
-
supportsLocationSearchOrder()
is false
optional
- This method must be implemented if
supportsLocationSearchOrder()
is true.
void orderByItem(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsItemSearchOrder()
ItemSearchOrder
is available. 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.
ItemSearchOrderRecord getItemSearchOrderRecord(Type itemRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.itemRecordType
- an item record typeNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemRecordType)
is false
mandatory
- This method must be implemented.