public interface TodoProducerSearchOrder extends OsidRuleSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CyclicEventSearchOrder |
getCyclicEventSearchOrder()
Gets the cyclic event search order.
|
StockSearchOrder |
getStockSearchOrder()
Gets the stock search order.
|
TodoProducerSearchOrderRecord |
getTodoProducerSearchOrderRecord(Type todoProducerRecordType)
Gets the todo producer search order record corresponding to the given
todo producer record
Type. |
void |
orderByCreationRule(SearchOrderStyle style)
Specifies a preference for ordering the result set by the creation
rule flag.
|
void |
orderByCyclicEvent(SearchOrderStyle style)
Specifies a preference for ordering the result set by the cyclic
event.
|
void |
orderByStock(SearchOrderStyle style)
Specifies a preference for ordering the result set by the stock.
|
void |
orderByStockLevel(SearchOrderStyle style)
Specifies a preference for ordering the result set by the stock level.
|
boolean |
supportsCyclicEventSearchOrder()
Tests if a cyclic event search order is available.
|
boolean |
supportsStockSearchOrder()
Tests if a stock search order is available.
|
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByCreationRule(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCyclicEvent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCyclicEventSearchOrder()
true
if a cyclic event search order is
available, false
otherwisemandatory
- This method must be implemented. CyclicEventSearchOrder getCyclicEventSearchOrder()
UnimplementedException
-
supportsCyclicEventSearchOrder()
is false
optional
- This method must be implemented if
supportsCyclicEventSearchOrder()
is true.
void orderByStock(SearchOrderStyle style)
style
- 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 orderByStockLevel(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. TodoProducerSearchOrderRecord getTodoProducerSearchOrderRecord(Type todoProducerRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.todoProducerRecordType
- a todo producer record typeNullArgumentException
- todoProducerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(todoProducerRecordType)
is false
mandatory
- This method must be implemented.