Interface AuctionConstrainerSearchSession

All Superinterfaces:
AuctionConstrainerQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuctionConstrainerSearchSession extends AuctionConstrainerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

  • federated auction house view: searches include auction constrainer 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 constrainer in this auction house
AuctionConstrainers may have a query record indicated by their respective record types. The query record is accessed via the AuctionConstrainerQuery .

  • Method Details

    • getAuctionConstrainerSearch

      AuctionConstrainerSearch getAuctionConstrainerSearch()
      Gets an auction constrainer search.
      Returns:
      the auction constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainerSearchOrder

      AuctionConstrainerSearchOrder getAuctionConstrainerSearchOrder()
      Gets an auction constrainer search order. The AuctionConstrainerSearchOrder is supplied to an AuctionConstrainerSearch to specify the ordering of results.
      Returns:
      the auction constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainersBySearch

      AuctionConstrainerSearchResults getAuctionConstrainersBySearch(AuctionConstrainerQuery auctionConstrainerQuery, AuctionConstrainerSearch auctionConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      auctionConstrainerQuery - the auction constrainer query
      auctionConstrainerSearch - the auction constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - auctionConstrainerQuery or auctionConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auctionConstrainerQuery or auctionConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainerQueryFromInspector

      AuctionConstrainerQuery getAuctionConstrainerQueryFromInspector(AuctionConstrainerQueryInspector auctionConstrainerQueryInspector)
      Gets an auction constrainer query from an inspector. The inspector is available from an AuctionConstrainerSearchResults .
      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.