OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.ItemSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByOrder
Description

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

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsOrderSearchOrder
Description

Tests if an order order is available.

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

Gets the order order.

Returnosid.ordering.OrderSearchOrderthe order search order
ErrorsUNIMPLEMENTED supportsOrderSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsOrderSearchOrder() is true.
MethodorderByDerived
Description

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

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByProduct
Description

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

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsProductSearchOrder
Description

Tests if a product order is available.

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

Gets the product order.

Returnosid.ordering.ProductSearchOrderthe product search order
ErrorsUNIMPLEMENTED supportsProductSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsProductSearchOrder() is true.
MethodorderByQuantity
Description

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

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchOrderRecord
Description

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

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.ordering.records.ItemSearchOrderRecordthe item search order record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.