Interface AuctionConstrainerSmartAuctionHouseSession

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

This session manages queries and sequencing to create "smart" dynamic auction houses. An AuctionConstrainerQuery can be retrieved from this session and mapped to this AuctionHouse to create a virtual collection of auction constrainers. The auction constrainer may be sequenced using the AuctionConstrainerSearchOrder from this session.

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

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

    • getAuctionConstrainerQuery

      AuctionConstrainerQuery getAuctionConstrainerQuery()
      Gets an auction constrainer query.
      Returns:
      the auction constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainerSearchOrder

      AuctionConstrainerSearchOrder getAuctionConstrainerSearchOrder()
      Gets an auction constrainer search order.
      Returns:
      the auction constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAuctionConstrainerQuery

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

    • inspectAuctionConstrainerQuery

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

    • applyAuctionConstrainerSequencing

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

    • getAuctionConstrainerQueryFromInspector

      AuctionConstrainerQuery getAuctionConstrainerQueryFromInspector(AuctionConstrainerQueryInspector auctionConstrainerQueryInspector)
      Gets an auction constrainer query from an inspector.
      Parameters:
      auctionConstrainerQueryInspector - an auction constrainer query inspector
      Returns:
      the auction constrainer query
      Throws:
      NullArgumentException - auctionConstrainerQueryInspector is null
      UnsupportedException - auctionConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.