Interface BidEnablerSmartAuctionHouseSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A BidEnablerQuery can be retrieved from this session and mapped to this AuctionHouse to create a virtual collection of BidEnablers . The bid enablers may be sequenced using the BidEnablerSearchOrder from this session.

This AuctionHouse has a default query that matches any bid enabler and a default search order that specifies no sequencing. The queries may be examined using a BidEnablerQueryInspector. Th e query may be modified by converting the inspector back to a BidEnablerQuery .

  • Method Details

    • getAuctionHouseId

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

    • getAuctionHouse

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

    • canManageSmartAuctionHouses

      boolean canManageSmartAuctionHouses()
      Tests if this user can manage smart auction houses. 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 auction house management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBidEnablerQuery

      BidEnablerQuery getBidEnablerQuery()
      Gets a bid enabler query.
      Returns:
      the bid enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getBidEnablerSearchOrder

      BidEnablerSearchOrder getBidEnablerSearchOrder()
      Gets a bid enabler search order.
      Returns:
      the bid enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyBidEnablerQuery

      void applyBidEnablerQuery(BidEnablerQuery bidEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a bid enabler query to this auction house.
      Parameters:
      bidEnablerQuery - the bid enabler query
      Throws:
      NullArgumentException - bidEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - bidEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectBidEnablerQuery

      BidEnablerQueryInspector inspectBidEnablerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a bid enabler query inspector for this auction house.
      Returns:
      the bid enabler query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyBidEnablerSequencing

      void applyBidEnablerSequencing(BidEnablerSearchOrder bidEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a bid enabler search order to this auction house.
      Parameters:
      bidEnablerSearchOrder - the bid enabler search order
      Throws:
      NullArgumentException - bidEnablerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - bidEnablerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getBidEnablerQueryFromInspector

      BidQuery getBidEnablerQueryFromInspector(BidEnablerQueryInspector bidEnablerQueryInspector)
      Gets a bid enabler query from an inspector.
      Parameters:
      bidEnablerQueryInspector - a bid enabler query inspector
      Returns:
      the bid enabler query
      Throws:
      NullArgumentException - bidEnablerQueryInspector is null
      UnsupportedException - bidEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.