Interface ItemQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ItemSearchSession
public interface ItemQuerySession extends OsidSession

This session provides methods for searching among Items. The search query is constructed using the ItemQuery.

This session defines views that offer differing behaviors for searching.

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

Items may have a query record indicated by their respective record types. The query record is accessed via the ItemQuery.

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

    • canSearchItems

      boolean canSearchItems()
      Tests if this user can perform Item 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 items 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.

    • getItemQuery

      ItemQuery getItemQuery()
      Gets an item query.
      Returns:
      the item query
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByQuery

      ItemList getItemsByQuery(ItemQuery itemQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Items matching the given item query.
      Parameters:
      itemQuery - the item query
      Returns:
      the returned ItemList
      Throws:
      NullArgumentException - itemQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - itemQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.