org.osid.checklist.mason

Interface TodoProducerSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface TodoProducerSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

orderByCreationRule

void orderByCreationRule(SearchOrderStyle style)

Specifies a preference for ordering the result set by the creation rule flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCyclicEvent

void orderByCyclicEvent(SearchOrderStyle style)

Specifies a preference for ordering the result set by the cyclic event.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCyclicEventSearchOrder

boolean supportsCyclicEventSearchOrder()

Tests if a cyclic event search order is available.

Returns:

true if a cyclic event search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCyclicEventSearchOrder

CyclicEventSearchOrder getCyclicEventSearchOrder()

Gets the cyclic event search order.

Returns:

the cyclic event search order

Throws:

UnimplementedException - supportsCyclicEventSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsCyclicEventSearchOrder() is true.

orderByStock

void orderByStock(SearchOrderStyle style)

Specifies a preference for ordering the result set by the stock.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsStockSearchOrder

boolean supportsStockSearchOrder()

Tests if a stock search order is available.

Returns:

true if a stock search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStockSearchOrder

StockSearchOrder getStockSearchOrder()

Gets the stock search order.

Returns:

the stock search order

Throws:

UnimplementedException - supportsStockSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsStockSearchOrder() is true.

orderByStockLevel

void orderByStockLevel(SearchOrderStyle style)

Specifies a preference for ordering the result set by the stock level.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getTodoProducerSearchOrderRecord

TodoProducerSearchOrderRecord getTodoProducerSearchOrderRecord(Type todoProducerRecordType)
                                                               throws OperationFailedException

Gets the todo producer search order record corresponding to the given todo producer record Type. Multiple retrievals return the same underlying object.

Parameters:

todoProducerRecordType - a todo producer record type

Returns:

the todo producer search order record

Throws:

NullArgumentException - todoProducerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoProducerRecordType) is false

Compliance:

mandatory - This method must be implemented.