Interface AuctionProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AuctionProcessorSearchSession
public interface AuctionProcessorQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

    • canSearchAuctionProcessors

      boolean canSearchAuctionProcessors()
      Tests if this user can perform AuctionProcessor lookups. 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 auction processor in auction houses which are children of this broker 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 lookups to this auction house only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAuctionProcessorQuery

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

    • getAuctionProcessorsByQuery

      AuctionProcessorList getAuctionProcessorsByQuery(AuctionProcessorQuery auctionProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AuctionProcessors matching the given search.
      Parameters:
      auctionProcessorQuery - the auction processor query
      Returns:
      the returned AuctionProcessorList
      Throws:
      NullArgumentException - auctionProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auctionProcessorQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.