Interface AuctionProcessorSearchSession

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

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

getAuctionProcessorsByQuery() is the basic search method and returns a list of AuctionProcessors . A more advanced search may be performed with getAuctionProcessorsBySearch() . It accepts an AuctionProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as bidding. getAuctionProcessorsBySearch() returns an AuctionProcessorSearchResults that can be used to access the resulting AuctionProcessorList or be used to perform a search within the result set through AuctionProcessorSearch .

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

  • Method Details

    • getAuctionProcessorSearch

      AuctionProcessorSearch getAuctionProcessorSearch()
      Gets an auction processor search.
      Returns:
      the auction processor search
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionProcessorSearchOrder

      AuctionProcessorSearchOrder getAuctionProcessorSearchOrder()
      Gets an auction processor search order. The AuctionProcessorSearchOrder is supplied to an AuctionProcessorSearch to specify the ordering of results.
      Returns:
      the auction processor search order
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionProcessorsBySearch

      AuctionProcessorSearchResults getAuctionProcessorsBySearch(AuctionProcessorQuery auctionProcessorQuery, AuctionProcessorSearch auctionProcessorSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      auctionProcessorQuery - the auction processor query
      auctionProcessorSearch - the auction processor search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - auctionProcessorQuery or auctionProcessorSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auctionProcessorQuery or auctionProcessorSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionProcessorQueryFromInspector

      AuctionProcessorQuery getAuctionProcessorQueryFromInspector(AuctionProcessorQueryInspector auctionProcessorQueryInspector)
      Gets an auction processor query from an inspector. The inspector is available from an AuctionProcessorSearchResults .
      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.