org.osid.inventory

Interface StockSearchOrder

All Superinterfaces:

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

public interface StockSearchOrder
extends OsidObjectSearchOrder, OsidFederateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
StockSearchOrderRecord	getStockSearchOrderRecord(Type stockRecordType) Gets the stock search order record corresponding to the given stock record Type.
void	orderByLocationDescription(SearchOrderStyle style) Specifies a preference for ordering the result set by the location description.
void	orderBySKU(SearchOrderStyle style) Specifies a preference for ordering the result set by the sku.

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

orderBySKU

void orderBySKU(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLocationDescription

void orderByLocationDescription(SearchOrderStyle style)

Specifies a preference for ordering the result set by the location description.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getStockSearchOrderRecord

StockSearchOrderRecord getStockSearchOrderRecord(Type stockRecordType)
                                                 throws OperationFailedException

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

Parameters:

stockRecordType - a stock record type

Returns:

the stock search order record

Throws:

NullArgumentException - stockRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stockRecordType) is false

Compliance:

mandatory - This method must be implemented.