Interface | osid.inventory.shipment.ShipmentSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing shipment searches. | ||
Method | searchAmongShipments | ||
Description |
Execute this search among the given list of shipments. | ||
Parameters | osid.id.IdList | shipmentIds | list of shipments |
Errors | NULL_ARGUMENT | shipmentIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderShipmentResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.inventory.shipment.ShipmentSearchOrder | shipmentSearchOrder | shipment search order |
Errors | NULL_ARGUMENT | shipmentSearchOrder is null | |
UNSUPPORTED | shipmentSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentSearchRecord | ||
Description |
Gets the shipment search record corresponding to the
given shipment search record | ||
Parameters | osid.type.Type | shipmentSearchRecordType | a shipment search record type |
Return | osid.inventory.shipment.records.ShipmentSearchRecord | the shipment search record | |
Errors | NULL_ARGUMENT | shipmentSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(shipmentSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |