OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.OrderItemSearch
Implementsosid.OsidSearch
Used Byosid.ordering.OrderItemSearchSession
Description

The search interface for governing order item searches.

MethodsearchAmongOrderItems
Description

Execute this search among the given list of order items.

Parametersosid.id.IdListorderItemIds list of order items
ErrorsNULL_ARGUMENT orderItemIds is null
Compliancemandatory This method must be implemented.
MethodorderOrderItemResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.OrderItemSearchOrderorderItemSearchOrder order item search order
ErrorsNULL_ARGUMENT orderItemSearchOrder is null
UNSUPPORTED orderItemSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetOrderItemSearchRecord
Description

Gets the order item search record corresponding to the given order item search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeorderItemSearchRecordType an order item search record type
Returnosid.ordering.records.OrderItemSearchRecord the order item search record
ErrorsNULL_ARGUMENT orderItemSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(order itemSearchRecordType) is false
Compliancemandatory This method must be implemented.