OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.ShipmentSearch
Implementsosid.OsidSearch
Description

The search interface for governing shipment searches.

MethodsearchAmongShipments
Description

Execute this search among the given list of shipments.

Parametersosid.id.IdListshipmentIdslist of shipments
ErrorsNULL_ARGUMENT shipmentIds is null
CompliancemandatoryThis method must be implemented.
MethodorderShipmentResults
Description

Specify an ordering to the search results.

Parametersosid.inventory.shipment.ShipmentSearchOrdershipmentSearchOrdershipment search order
ErrorsNULL_ARGUMENT shipmentSearchOrder is null
UNSUPPORTED shipmentSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetShipmentSearchRecord
Description

Gets the shipment search 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.ShipmentSearchRecordthe shipment search record
ErrorsNULL_ARGUMENT shipmentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(shipmentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.