Interface | osid.inventory.shipment.ShipmentSmartWarehouseSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getWarehouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Warehouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouse | ||
Description |
Gets the | ||
Return | osid.inventory.Warehouse | the warehouse | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartWarehouses | ||
Description |
Tests if this user can manage smart warehouses. A
return of true does not guarantee successful assessment. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart warehouse management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentQuery | ||
Description |
Gets a shipment query. | ||
Return | osid.inventory.shipment.ShipmentQuery | the shipment query | |
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentSearchOrder | ||
Description |
Gets a shipment search order. | ||
Return | osid.inventory.shipment.ShipmentSearchOrder | the shipment search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyShipmentQuery | ||
Description |
Applies a shipment query to this warehouse. | ||
Parameters | osid.inventory.shipment.ShipmentQuery | shipmentQuery | the shipment query |
Errors | NULL_ARGUMENT | shipmentQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | shipmentQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectShipmentQuery | ||
Description |
Gets a shipment query inspector for this warehouse. | ||
Return | osid.inventory.shipment.ShipmentQueryInspector | the shipment query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyShipmentSequencing | ||
Description |
Applies a shipment search order to this warehouse. | ||
Parameters | osid.inventory.shipment.ShipmentSearchOrder | shipmentSearchOrder | the shipment search order |
Errors | NULL_ARGUMENT | shipmentSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | shipmentSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentQueryFromInspector | ||
Description |
Gets a shipment query from an inspector. | ||
Parameters | osid.inventory.shipment.ShipmentQueryInspector | shipmentQueryInspector | a query inspector |
Return | osid.inventory.shipment.ShipmentQuery | the shipment query | |
Errors | NULL_ARGUMENT | shipmentQueryInspector is null | |
UNSUPPORTED | shipmentQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |