Interface StockSmartWarehouseSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A StockQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Stocks . The stocks may be sequenced using the StockSearchOrder from this session.

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

  • 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.

    • getStockQuery

      StockQuery getStockQuery()
      Gets a stock query.
      Returns:
      the stock query
      Compliance:
      mandatory - This method must be implemented.

    • getStockSearchOrder

      StockSearchOrder getStockSearchOrder()
      Gets a stock search order.
      Returns:
      the stock search order
      Compliance:
      mandatory - This method must be implemented.

    • applyStockQuery

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

    • inspectStockQuery

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

    • applyStockSequencing

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

    • getStockQueryFromInspector

      StockQuery getStockQueryFromInspector(StockQueryInspector stockQueryInspector)
      Gets a stock query from an inspector.
      Parameters:
      stockQueryInspector - a query inspector
      Returns:
      the stock query
      Throws:
      NullArgumentException - stockQueryInspector is null
      UnsupportedException - stockQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.