org.osid.inventory.shipment

Interface EntrySearchOrder

All Superinterfaces:

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

public interface EntrySearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
EntrySearchOrderRecord	getEntrySearchOrderRecord(Type entryRecordType) Gets the entry search order record corresponding to the given entry record Type.
ItemSearchOrder	getItemSearchOrder() Gets the item search order.
ModelSearchOrder	getModelSearchOrder() Gets the model search order.
StockSearchOrder	getStockSearchOrder() Gets the shipment order.
void	orderByItem(SearchOrderStyle style) Specifies a preference for ordering the result set by the item.
void	orderByModel(SearchOrderStyle style) Specifies a preference for ordering the result set by the model.
void	orderByQuantity(SearchOrderStyle style) Specifies a preference for ordering the result set by quantity.
void	orderByStock(SearchOrderStyle style) Specifies a preference for ordering the result set by stock.
void	orderByUnitType(SearchOrderStyle style) Specifies a preference for ordering the result set by the unit type.
boolean	supportsItemSearchOrder() Tests if an item search order is available.
boolean	supportsModelSearchOrder() Tests if a model search order is available.
boolean	supportsStockSearchOrder() Tests if a stock search order 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 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 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 shipment order.

Returns:

the stock search order

Throws:

UnimplementedException - supportsStockSearchOrder() is false

Compliance:

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

orderByModel

void orderByModel(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsModelSearchOrder

boolean supportsModelSearchOrder()

Tests if a model search order is available.

Returns:

true if a model search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getModelSearchOrder

ModelSearchOrder getModelSearchOrder()

Gets the model search order.

Returns:

the item search order

Throws:

UnimplementedException - supportsModelSearchOrder() is false

Compliance:

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

orderByItem

void orderByItem(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsItemSearchOrder

boolean supportsItemSearchOrder()

Tests if an item search order is available.

Returns:

true if an item search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getItemSearchOrder

ItemSearchOrder getItemSearchOrder()

Gets the item search order.

Returns:

the item search order

Throws:

UnimplementedException - supportsItemSearchOrder() is false

Compliance:

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

orderByQuantity

void orderByQuantity(SearchOrderStyle style)

Specifies a preference for ordering the result set by quantity.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByUnitType

void orderByUnitType(SearchOrderStyle style)

Specifies a preference for ordering the result set by the unit type.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getEntrySearchOrderRecord

EntrySearchOrderRecord getEntrySearchOrderRecord(Type entryRecordType)
                                                 throws OperationFailedException

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

Parameters:

entryRecordType - an entry record type

Returns:

the entry search order record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.