org.osid.inventory

Interface ItemSearchOrder

All Superinterfaces:

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

public interface ItemSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ItemSearchOrder	getItemSearchOrder() Gets the item order for a stock.
ItemSearchOrderRecord	getItemSearchOrderRecord(Type itemRecordType) Gets the item search order record corresponding to the given item record Type.
LocationSearchOrder	getLocationSearchOrder() Gets the location order for a stock.
StockSearchOrder	getStockSearchOrder() Gets the search order for a stock.
void	orderByItem(SearchOrderStyle style) Specifies a preference for ordering the result set by the containing item.
void	orderByLocation(SearchOrderStyle style) Specifies a preference for ordering the result set by the location.
void	orderByLocationDescription(SearchOrderStyle style) Specifies a preference for ordering the result set by the location description.
void	orderByPropertyTag(SearchOrderStyle style) Specifies a preference for ordering the result set by the property tag.
void	orderBySerialNumber(SearchOrderStyle style) Specifies a preference for ordering the result set by the serial number.
void	orderByStock(SearchOrderStyle style) Specifies a preference for ordering the result set by the stock.
boolean	supportsItemSearchOrder() Tests if an ItemSearchOrder is available.
boolean	supportsLocationSearchOrder() Tests if a LocationSearchOrder is available.
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.

orderByPropertyTag

void orderByPropertyTag(SearchOrderStyle style)

Specifies a preference for ordering the result set by the property tag.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySerialNumber

void orderBySerialNumber(SearchOrderStyle style)

Specifies a preference for ordering the result set by the serial number.

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.

orderByLocation

void orderByLocation(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsLocationSearchOrder

boolean supportsLocationSearchOrder()

Tests if a LocationSearchOrder is available.

Returns:

true if a location search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLocationSearchOrder

LocationSearchOrder getLocationSearchOrder()

Gets the location order for a stock.

Returns:

the location search order

Throws:

UnimplementedException - supportsLocationSearchOrder() is false

Compliance:

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

orderByItem

void orderByItem(SearchOrderStyle style)

Specifies a preference for ordering the result set by the containing 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 ItemSearchOrder 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 order for a stock.

Returns:

the location search order

Throws:

UnimplementedException - supportsItemSearchOrder() is false

Compliance:

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

getItemSearchOrderRecord

ItemSearchOrderRecord getItemSearchOrderRecord(Type itemRecordType)
                                               throws OperationFailedException

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

Parameters:

itemRecordType - an item record type

Returns:

the item search order record

Throws:

NullArgumentException - itemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemRecordType) is false

Compliance:

mandatory - This method must be implemented.