Interface OrderQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
OrderSearchSession
public interface OrderQuerySession extends OsidSession

This session provides methods for searching Order objects. The search query is constructed using the OrderQuery. The item record Type also specifies the record for the item query.

Orders may have a query record indicated by their respective record types. The query record is accessed via the OrderQuery. The returns in this session may not be cast directly to these interfaces.

  • Method Details

    • getStoreId

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

    • getStore

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

    • canSearchOrders

      boolean canSearchOrders()
      Tests if this user can perform susbcription searches. 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 wish to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedStoreView

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

    • useIsolatedStoreView

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

    • getOrderQuery

      OrderQuery getOrderQuery()
      Gets an order query.
      Returns:
      the order query
      Compliance:
      mandatory - This method must be implemented.

    • getOrdersByQuery

      OrderList getOrdersByQuery(OrderQuery orderQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of orders matching the given order query.
      Parameters:
      orderQuery - the order query
      Returns:
      the returned OrderList
      Throws:
      NullArgumentException - orderQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - orderQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.