OSID Logo
OSID Specifications
inventory shipment package
Version 3.1.0
Interfaceosid.inventory.shipment.ShipmentSearchResults
Implementsosid.OsidSearchResults
Used Byosid.inventory.shipment.ShipmentSearchSession
Description

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

MethodgetShipments
Description

Gets the shipment list resulting from a search.

Returnosid.inventory.shipment.ShipmentList the shipment list
ErrorsILLEGAL_STATE the shipment list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetShipmentQueryInspector
Description

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

Returnosid.inventory.shipment.ShipmentQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetShipmentSearchResultsRecord
Description

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

Parametersosid.type.TypeshipmentSearchRecordType a shipment search record type
Returnosid.inventory.shipment.records.ShipmentSearchResultsRecord the shipment search results record
ErrorsNULL_ARGUMENT shipmentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(shipmentSearchRecordType) is false
Compliancemandatory This method must be implemented.