Interface AuctionSmartAuctionHouseSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuctionQuery can be retrieved from this session and auctionHouseped to this AuctionHouse to create a virtual collection of Auctions . The auctions may be sequenced using the AuctionSearchOrder from this session.

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

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

    • getAuctionQuery

      AuctionQuery getAuctionQuery()
      Gets an auction query.
      Returns:
      the auction query
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionSearchOrder

      AuctionSearchOrder getAuctionSearchOrder()
      Gets an auction search order.
      Returns:
      the auction search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAuctionQuery

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

    • inspectAuctionQuery

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

    • applyAuctionSequencing

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

    • getAuctionQueryFromInspector

      AuctionQuery getAuctionQueryFromInspector(AuctionQueryInspector auctionQueryInspector)
      Gets an auction query from an inspector.
      Parameters:
      auctionQueryInspector - an auction query inspector
      Returns:
      the auction query
      Throws:
      NullArgumentException - auctionQueryInspector is null
      UnsupportedException - auctionQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.