OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.ShipmentSmartWarehouseSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A ShipmentQuery can be retrieved from this session and mapped to this Warehouse to create a virtual collection of Shipments. The shipments may be sequenced using the ShipmentSearchOrder from this session.

This Warehouse has a default query that matches any shipment and a default search order that specifies no sequencing. The queries may be examined using a ShipmentQueryInspector. The query may be modified by converting the inspector back to a ShipmentQuery.

MethodgetWarehouseId
Description

Gets the Warehouse Id associated with this session.

Returnosid.id.Idthe Warehouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetWarehouse
Description

Gets the Warehouse associated with this session.

Returnosid.inventory.Warehousethe warehouse
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartWarehouses
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart warehouse management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetShipmentQuery
Description

Gets a shipment query.

Returnosid.inventory.shipment.ShipmentQuerythe shipment query
CompliancemandatoryThis method must be implemented.
MethodgetShipmentSearchOrder
Description

Gets a shipment search order.

Returnosid.inventory.shipment.ShipmentSearchOrderthe shipment search order
CompliancemandatoryThis method must be implemented.
MethodapplyShipmentQuery
Description

Applies a shipment query to this warehouse.

Parametersosid.inventory.shipment.ShipmentQueryshipmentQuerythe shipment query
ErrorsNULL_ARGUMENT shipmentQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED shipmentQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectShipmentQuery
Description

Gets a shipment query inspector for this warehouse.

Returnosid.inventory.shipment.ShipmentQueryInspectorthe shipment query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyShipmentSequencing
Description

Applies a shipment search order to this warehouse.

Parametersosid.inventory.shipment.ShipmentSearchOrdershipmentSearchOrderthe shipment search order
ErrorsNULL_ARGUMENT shipmentSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED shipmentSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetShipmentQueryFromInspector
Description

Gets a shipment query from an inspector.

Parametersosid.inventory.shipment.ShipmentQueryInspectorshipmentQueryInspectora query inspector
Returnosid.inventory.shipment.ShipmentQuerythe shipment query
ErrorsNULL_ARGUMENT shipmentQueryInspector is null
UNSUPPORTED shipmentQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.