OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.ShipmentSearchResults
Implementsosid.OsidSearchResults
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.ShipmentListthe shipment list
ErrorsILLEGAL_STATEthe shipment list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetShipmentQueryInspector
Description

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

Returnosid.inventory.shipment.ShipmentQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypeshipmentSearchRecordTypea shipment search record type
Returnosid.inventory.shipment.records.ShipmentSearchResultsRecordthe shipment search results record
ErrorsNULL_ARGUMENT shipmentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(shipmentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.