org.osid.ordering

Interface ItemSearchOrder

All Superinterfaces:

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

public interface ItemSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ItemSearchOrderRecord	getItemSearchOrderRecord(Type itemRecordType) Gets the item search record order corresponding to the given item record Type.
OrderSearchOrder	getOrderSearchOrder() Gets the order order.
ProductSearchOrder	getProductSearchOrder() Gets the product order.
void	orderByDerived(SearchOrderStyle style) Specifies a preference for ordering the result set by the derived flag.
void	orderByOrder(SearchOrderStyle style) Specifies a preference for ordering the result set by the order.
void	orderByProduct(SearchOrderStyle style) Specifies a preference for ordering the result set by the product.
void	orderByQuantity(SearchOrderStyle style) Specifies a preference for ordering the result set by the quantity.
boolean	supportsOrderSearchOrder() Tests if an order order is available.
boolean	supportsProductSearchOrder() Tests if a product order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByOrder

void orderByOrder(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsOrderSearchOrder

boolean supportsOrderSearchOrder()

Tests if an order order is available.

Returns:

true if an order order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOrderSearchOrder

OrderSearchOrder getOrderSearchOrder()

Gets the order order.

Returns:

the order search order

Throws:

UnimplementedException - supportsOrderSearchOrder() is false

Compliance:

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

orderByDerived

void orderByDerived(SearchOrderStyle style)

Specifies a preference for ordering the result set by the derived flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByProduct

void orderByProduct(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProductSearchOrder

boolean supportsProductSearchOrder()

Tests if a product order is available.

Returns:

true if a product order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProductSearchOrder

ProductSearchOrder getProductSearchOrder()

Gets the product order.

Returns:

the product search order

Throws:

UnimplementedException - supportsProductSearchOrder() is false

Compliance:

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

orderByQuantity

void orderByQuantity(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getItemSearchOrderRecord

ItemSearchOrderRecord getItemSearchOrderRecord(Type itemRecordType)
                                               throws OperationFailedException

Gets the item search record order 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.