Interface BidEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
BidEnablerSearchSession
public interface BidEnablerQuerySession extends OsidSession

This session provides methods for searching among BidEnabler objects. The search query is constructed using the BidEnablerQuery .

This session defines views that offer differing behaviors for searching.

  • federated auction house view: searches include bid enablers in auction houses of which this auction house is an ancestor in the auction house hierarchy
  • isolated auction house view: searches are restricted to bid enablers in this auction house

Bid enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.

    • canSearchBidEnablers

      boolean canSearchBidEnablers()
      Tests if this user can perform BidEnabler searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedAuctionHouseView

      void useFederatedAuctionHouseView()
      Federates the view for methods in this session. A federated view will include bid enablers in auction houses which are children of this auction house in the auction house hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAuctionHouseView

      void useIsolatedAuctionHouseView()
      Isolates the view for methods in this session. An isolated view restricts searches to this auction house only.
      Compliance:
      mandatory - This method is must be implemented.

    • getBidEnablerQuery

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

    • getBidEnablersByQuery

      BidEnablerList getBidEnablersByQuery(BidEnablerQuery bidEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of BidEnablers matching the given search.
      Parameters:
      bidEnablerQuery - the bid enabler query
      Returns:
      the returned BidEnablerList
      Throws:
      NullArgumentException - bidEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - bidEnablerQuery did not originate from getBidEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.