Interface AuctionProcessorSmartAuctionHouseSession

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

This session manages queries and sequencing to create "smart" dynamic auction houses. An AuctionProcessorQuery can be retrieved from this session and mapped to this AuctionHouse to create a virtual collection of auction processors. The auction processor may be sequenced using the AuctionProcessorSearchOrder from this session.

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

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

    • getAuctionProcessorQuery

      AuctionProcessorQuery getAuctionProcessorQuery()
      Gets an auction processor query.
      Returns:
      the auction processor query
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionProcessorSearchOrder

      AuctionProcessorSearchOrder getAuctionProcessorSearchOrder()
      Gets an auction processor search order.
      Returns:
      the auction processor search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAuctionProcessorQuery

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

    • inspectAuctionProcessorQuery

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

    • applyAuctionProcessorSequencing

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

    • getAuctionProcessorQueryFromInspector

      AuctionProcessorQuery getAuctionProcessorQueryFromInspector(AuctionProcessorQueryInspector auctionProcessorQueryInspector)
      Gets an auction processor query from an inspector.
      Parameters:
      auctionProcessorQueryInspector - an auction processor query inspector
      Returns:
      the auction processor query
      Throws:
      NullArgumentException - auctionProcessorQueryInspector is null
      UnsupportedException - auctionProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.