Interface ShipmentSmartWarehouseSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ShipmentSmartWarehouseSession extends OsidSession

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 .

  • Method Details

    • getWarehouseId

      Id getWarehouseId()
      Gets the Warehouse Id associated with this session.
      Returns:
      the Warehouse Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouse

      Warehouse getWarehouse() throws OperationFailedException, PermissionDeniedException
      Gets the Warehouse associated with this session.
      Returns:
      the warehouse
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartWarehouses

      boolean canManageSmartWarehouses()
      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.
      Returns:
      false if smart warehouse management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getShipmentQuery

      ShipmentQuery getShipmentQuery()
      Gets a shipment query.
      Returns:
      the shipment query
      Compliance:
      mandatory - This method must be implemented.

    • getShipmentSearchOrder

      ShipmentSearchOrder getShipmentSearchOrder()
      Gets a shipment search order.
      Returns:
      the shipment search order
      Compliance:
      mandatory - This method must be implemented.

    • applyShipmentQuery

      void applyShipmentQuery(ShipmentQuery shipmentQuery) throws OperationFailedException, PermissionDeniedException
      Applies a shipment query to this warehouse.
      Parameters:
      shipmentQuery - the shipment query
      Throws:
      NullArgumentException - shipmentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - shipmentQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectShipmentQuery

      ShipmentQueryInspector inspectShipmentQuery() throws OperationFailedException, PermissionDeniedException
      Gets a shipment query inspector for this warehouse.
      Returns:
      the shipment query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyShipmentSequencing

      void applyShipmentSequencing(ShipmentSearchOrder shipmentSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a shipment search order to this warehouse.
      Parameters:
      shipmentSearchOrder - the shipment search order
      Throws:
      NullArgumentException - shipmentSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - shipmentSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getShipmentQueryFromInspector

      ShipmentQuery getShipmentQueryFromInspector(ShipmentQueryInspector shipmentQueryInspector)
      Gets a shipment query from an inspector.
      Parameters:
      shipmentQueryInspector - a query inspector
      Returns:
      the shipment query
      Throws:
      NullArgumentException - shipmentQueryInspector is null
      UnsupportedException - shipmentQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.