OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.OrderSearchResults
Implementsosid.OsidSearchResults
Used Byosid.ordering.OrderSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetOrders
Description

Gets the order list resulting from a search.

Returnosid.ordering.OrderList the order list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetOrderQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.ordering.OrderQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetOrderSearchResultsRecord
Description

Gets the order search results 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.OrderSearchResultsRecord 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.