OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.OrderItemSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Used Byosid.ordering.OrderItemSearchSession
osid.ordering.OrderItemSmartStoreSession
Description

An interface for specifying the ordering of search results.

MethodorderByOrder
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsOrderSearchOrder
Description

Tests if an order order is available.

Returnboolean true if an order order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetOrderSearchOrder
Description

Gets the order order.

Returnosid.ordering.OrderSearchOrder the order search order
ErrorsUNIMPLEMENTED supportsOrderSearchOrder() is false
Complianceoptional This method must be implemented if supportsOrderSearchOrder() is true.
MethodorderByDerived
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByProduct
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsProductSearchOrder
Description

Tests if a product order is available.

Returnboolean true if a product order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetProductSearchOrder
Description

Gets the product order.

Returnosid.ordering.ProductSearchOrder the product search order
ErrorsUNIMPLEMENTED supportsProductSearchOrder() is false
Complianceoptional This method must be implemented if supportsProductSearchOrder() is true.
MethodorderByQuantity
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodgetOrderItemSearchOrderRecord
Description

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

Parametersosid.type.TypeorderItemRecordType an order item record type
Returnosid.ordering.records.OrderItemSearchOrderRecord the order item search order record
ErrorsNULL_ARGUMENT orderItemRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
Compliancemandatory This method must be implemented.