Interface PriceScheduleSmartStoreSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A PriceScheduleQuery can be retrieved from this session and mapped to this Store to create a virtual collection of PriceSchedules . The prices may be sequenced using the PriceScheduleSearchOrder from this session.

This Store has a default query that matches any price schedule and a default search order that specifies no sequencing. The queries may be examined using a PriceScheduleQueryInspector . The query may be modified by converting the inspector back to a PriceScheduleQuery .

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartStores

      boolean canManageSmartStores()
      Tests if this user can manage smart stores. A return of true does not guarantee successful authorization. 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 store management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPriceScheduleQuery

      PriceScheduleQuery getPriceScheduleQuery()
      Gets a price schedule query.
      Returns:
      the price schedule query
      Compliance:
      mandatory - This method must be implemented.

    • getPriceScheduleSearchOrder

      PriceScheduleSearchOrder getPriceScheduleSearchOrder()
      Gets a price schedule search order.
      Returns:
      the price schedule search order
      Compliance:
      mandatory - This method must be implemented.

    • applyPriceScheduleQuery

      void applyPriceScheduleQuery(PriceScheduleQuery priceQuery) throws OperationFailedException, PermissionDeniedException
      Applies a price schedule query to this store.
      Parameters:
      priceQuery - the price schedule query
      Throws:
      NullArgumentException - priceScheduleQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - priceScheduleQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectPriceScheduleQuery

      PriceScheduleQueryInspector inspectPriceScheduleQuery() throws OperationFailedException, PermissionDeniedException
      Gets a price schedule query inspector for this store.
      Returns:
      the price schedule query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyPriceScheduleSequencing

      void applyPriceScheduleSequencing(PriceScheduleSearchOrder priceScheduleSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a price schedule search order to this store.
      Parameters:
      priceScheduleSearchOrder - the price schedule search order
      Throws:
      NullArgumentException - priceScheduleSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - priceScheduleSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPriceScheduleQueryFromInspector

      PriceScheduleQuery getPriceScheduleQueryFromInspector(PriceScheduleQueryInspector priceScheduleQueryInspector)
      Gets a price schedule query from an inspector.
      Parameters:
      priceScheduleQueryInspector - a query inspector
      Returns:
      the price schedule query
      Throws:
      NullArgumentException - priceScheduleQueryInspector is null
      UnsupportedException - priceScheduleQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.