Interface AuctionConstrainerQuerySession

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

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

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

Auction constrainer may have a query record indicated by their respective record types. The query record is accessed via the AuctionConstrainerQuery .

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

    • canSearchAuctionConstrainers

      boolean canSearchAuctionConstrainers()
      Tests if this user can perform AuctionConstrainer 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 constrainer 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.

    • getAuctionConstrainerQuery

      AuctionConstrainerQuery getAuctionConstrainerQuery()
      Gets an auction constrainer query.
      Returns:
      the auction constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainersByQuery

      AuctionConstrainerList getAuctionConstrainersByQuery(AuctionConstrainerQuery auctionConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AuctionConstrainers matching the given search.
      Parameters:
      auctionConstrainerQuery - the auction constrainer query
      Returns:
      the returned AuctionConstrainerList
      Throws:
      NullArgumentException - auctionConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auctionConstrainerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.