Interface | osid.inventory.shipment.ShipmentSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getShipments | ||
Description |
Gets the shipment list resulting from a search. | ||
Return | osid.inventory.shipment.ShipmentList | the shipment list | |
Errors | ILLEGAL_STATE | the shipment list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.inventory.shipment.ShipmentQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentSearchResultsRecord | ||
Description |
Gets the shipment search results record corresponding
to the given shipment search record | ||
Parameters | osid.type.Type | shipmentSearchRecordType | a shipment search record type |
Return | osid.inventory.shipment.records.ShipmentSearchResultsRecord | the shipment search results 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. |