Interface PriceScheduleQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PriceScheduleSearchSession
public interface PriceScheduleQuerySession extends OsidSession

This session provides methods for searching PriceSchedule objects. The search query is constructed using the PriceScheduleQuery. The price schedule record Type also specifies the record for the price query.

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

    • canSearchPriceSchedules

      boolean canSearchPriceSchedules()
      Tests if this user can perform PriceSchedule 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 opt not 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 price schedules 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 searches to this store only.
      Compliance:
      mandatory - This method is must be implemented.

    • getPriceScheduleQuery

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

    • getPriceSchedulesByQuery

      PriceScheduleList getPriceSchedulesByQuery(PriceScheduleQuery priceScheduleQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of PriceSchedules matching the given price schedule query.
      Parameters:
      priceScheduleQuery - the price schedule query query
      Returns:
      the returned PriceScheduleList
      Throws:
      NullArgumentException - priceScheduleQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - priceScheduleQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.