org.osid.inventory.shipment

Interface ShipmentSearchOrder

All Superinterfaces:

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

public interface ShipmentSearchOrder
extends OsidObjectSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
OrderSearchOrder	getOrderSearchOrder() Specifies a preference for ordering the result set by the order.
ShipmentSearchOrderRecord	getShipmentSearchOrderRecord(Type shipmentRecordType) Gets the shipment search order record corresponding to the given shipment record Type.
ResourceSearchOrder	getSourceSearchOrder() Specifies a preference for ordering the result set by the source.
void	orderByDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the shipment date.
void	orderByOrder(SearchOrderStyle style) Specifies a preference for ordering the result set by the order.
void	orderBySource(SearchOrderStyle style) Specifies a preference for ordering the result set by the source.
boolean	supportsOrderSearchOrder() Tests if an order search order is available.
boolean	supportsSourceSearchOrder() Tests if a resource 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

orderBySource

void orderBySource(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSourceSearchOrder

boolean supportsSourceSearchOrder()

Tests if a resource search order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSourceSearchOrder

ResourceSearchOrder getSourceSearchOrder()

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

Returns:

the resource search order

Throws:

UnimplementedException - supportsSourceSearchOrder() is false

Compliance:

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

orderByOrder

void orderByOrder(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsOrderSearchOrder

boolean supportsOrderSearchOrder()

Tests if an order search order is available.

Returns:

true if an order search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOrderSearchOrder

OrderSearchOrder getOrderSearchOrder()

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

Returns:

the order search order

Throws:

UnimplementedException - supportsOrderSearchOrder() is false

Compliance:

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

orderByDate

void orderByDate(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getShipmentSearchOrderRecord

ShipmentSearchOrderRecord getShipmentSearchOrderRecord(Type shipmentRecordType)
                                                       throws OperationFailedException

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

Parameters:

shipmentRecordType - a shipment record type

Returns:

the shipment search order record

Throws:

NullArgumentException - shipmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(shipmentRecordType) is false

Compliance:

mandatory - This method must be implemented.