Interface PriceEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PriceEnablerSearchSession
public interface PriceEnablerQuerySession extends OsidSession

This session provides methods for searching among PriceEnabler objects. The search query is constructed using the PriceEnablerQuery .

This session defines views that offer differing behaviors for searching.

  • federated store view: searches include price enablers in stores of which this store is an ancestor in the store hierarchy
  • isolated store view: searches are restricted to price enablers in this store

Price enablers may have a query record indicated by their respective record types. The query record is accessed via the PriceEnablerQuery .

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

    • canSearchPriceEnablers

      boolean canSearchPriceEnablers()
      Tests if this user can perform PriceEnabler 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.

    • useFederatedStoreView

      void useFederatedStoreView()
      Federates the view for methods in this session. A federated view will include price enablers in stores which are children of this broker 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 lookups to this store only.
      Compliance:
      mandatory - This method is must be implemented.

    • getPriceEnablerQuery

      PriceEnablerQuery getPriceEnablerQuery()
      Gets a price enabler query.
      Returns:
      the price enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getPriceEnablersByQuery

      PriceEnablerList getPriceEnablersByQuery(PriceEnablerQuery priceEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of PriceEnablers matching the given price enabler query.
      Parameters:
      priceEnablerQuery - the price enabler query
      Returns:
      the returned PriceEnablerList
      Throws:
      NullArgumentException - priceEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - priceEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.