Interface StockQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
StockSearchSession
public interface StockQuerySession extends OsidSession

This session provides methods for searching among Stocks . The search query is constructed using the StockQuery .

This session defines views that offer differing behaviors for searching.

  • federated warehouse view: searches include stocks in warehouses of which this warehouse is an ancestor in the warehouse hierarchy
  • isolated warehouse view: searches are restricted to stocks in this warehouse

Stocks may have a query record indicated by their respective query record types. The query record is accessed via the 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.

    • canSearchStocks

      boolean canSearchStocks()
      Tests if this user can perform Stock lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedWarehouseView

      void useFederatedWarehouseView()
      Federates the view for methods in this session. A federated view will include stocks in warehouse which are children of this warehouse in the warehouse hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedWarehouseView

      void useIsolatedWarehouseView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this warehouse only.
      Compliance:
      mandatory - This method is must be implemented.

    • getStockQuery

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

    • getStocksByQuery

      StockList getStocksByQuery(StockQuery stockQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Stocks matching the given stock query.
      Parameters:
      stockQuery - the stock query
      Returns:
      the returned StockList
      Throws:
      NullArgumentException - stockQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stockQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.