Interface BidSmartAuctionHouseSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A BidQuery can be retrieved from this session and auctionHouseped to this AuctionHouse to create a virtual collection of Bids . The bids may be sequenced using the BidSearchOrder from this session.

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

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

    • getBidQuery

      BidQuery getBidQuery()
      Gets a bid query.
      Returns:
      the bid query
      Compliance:
      mandatory - This method must be implemented.

    • getBidSearchOrder

      BidSearchOrder getBidSearchOrder()
      Gets a bid search order.
      Returns:
      the bid search order
      Compliance:
      mandatory - This method must be implemented.

    • applyBidQuery

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

    • inspectBidQuery

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

    • applyBidSequencing

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

    • getBidQueryFromInspector

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