org.osid.inventory

Interface InventorySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable

public interface InventorySearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
InventorySearchOrderRecord	getInventorySearchOrderRecord(Type inventoryRecordType) Gets the inventory search order record corresponding to the given inventory record Type.
StockSearchOrder	getStockSearchOrder() Gets the search order for a stock.
void	orderByDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the date.
void	orderByQuantity(SearchOrderStyle style) Specifies a preference for ordering the result set by the quantity.
void	orderByStock(SearchOrderStyle style) Specifies a preference for ordering the result set by the stock.
boolean	supportsStockSearchOrder() Tests if a StockSearchOrder is available.

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

Method Detail

orderByStock

void orderByStock(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsStockSearchOrder

boolean supportsStockSearchOrder()

Tests if a StockSearchOrder 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 search order for a stock.

Returns:

the stock search order

Throws:

UnimplementedException - supportsStockSearchOrder() is false

Compliance:

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

orderByDate

void orderByDate(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByQuantity

void orderByQuantity(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getInventorySearchOrderRecord

InventorySearchOrderRecord getInventorySearchOrderRecord(Type inventoryRecordType)
                                                         throws OperationFailedException

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

Parameters:

inventoryRecordType - an inventory record type

Returns:

the inventory search order record

Throws:

NullArgumentException - inventoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inventoryRecordType) is false

Compliance:

mandatory - This method must be implemented.