OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetOrders
Description

Gets the order list resulting from a search.

Returnosid.ordering.OrderListthe order list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetOrderQueryInspector
Description

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

Returnosid.ordering.OrderQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypeorderSearchRecordTypea order search record type
Returnosid.ordering.records.OrderSearchResultsRecordthe order search record
ErrorsNULL_ARGUMENT orderSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(orderSearchRecordType) is false
CompliancemandatoryThis method must be implemented.