OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.OrderSearch
Implementsosid.OsidSearch
Used Byosid.ordering.OrderSearchSession
Description

The search interface for governing order searches.

MethodsearchAmongOrders
Description

Execute this search among the given list of orders.

Parametersosid.id.IdListorderIds list of orders
ErrorsNULL_ARGUMENT orderIds is null
Compliancemandatory This method must be implemented.
MethodorderOrderResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.OrderSearchOrderorderSearchOrder order search order
ErrorsNULL_ARGUMENT orderSearchOrder is null
UNSUPPORTED orderSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetOrderSearchRecord
Description

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

Parametersosid.type.TypeorderSearchRecordType an order search record type
Returnosid.ordering.records.OrderSearchRecord the order search record
ErrorsNULL_ARGUMENT orderSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(orderSearchRecordType) is false
Compliancemandatory This method must be implemented.