Interface BidEnablerAuctionHouseSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface BidEnablerAuctionHouseSession extends OsidSession

This session provides methods to retrieve BidEnabler to AuctionHouse mappings. A BidEnabler may appear in multiple AuctionHouse obje cts. Each auction house may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupBidEnablerAuctionHouseMappings

      boolean canLookupBidEnablerAuctionHouseMappings()
      Tests if this user can perform lookups of bid enabler/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeBidEnablerAuctionHouseView

      void useComparativeBidEnablerAuctionHouseView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryBidEnablerAuctionHouseView

      void usePlenaryBidEnablerAuctionHouseView()
      A complete view of the BidEnabler and AuctionHouse returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getBidEnablerIdsByAuctionHouse

      IdList getBidEnablerIdsByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of BidEnabler Ids associated with an AuctionHouse .
      Parameters:
      auctionHouseId - Id of the AuctionHouse
      Returns:
      list of related bid enabler Ids
      Throws:
      NotFoundException - auctionHouseId is not found
      NullArgumentException - auctionHouseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBidEnablersByAuctionHouse

      BidEnablerList getBidEnablersByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of BidEnablers associated with an AuctionHouse .
      Parameters:
      auctionHouseId - Id of the AuctionHouse
      Returns:
      list of related bid enablers
      Throws:
      NotFoundException - auctionHouseId is not found
      NullArgumentException - auctionHouseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBidEnablerIdsByAuctionHouses

      IdList getBidEnablerIdsByAuctionHouses(IdList auctionHouseIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of BidEnabler Ids corresponding to a list of Auction Houses .
      Parameters:
      auctionHouseIds - list of auction house Ids
      Returns:
      list of bid enabler Ids
      Throws:
      NullArgumentException - auctionHouseIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBidEnablersByAuctionHouses

      BidEnablerList getBidEnablersByAuctionHouses(IdList auctionHouseIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of BidEnablers corresponding to a list of Auction Houses .
      Parameters:
      auctionHouseIds - list of auction house Ids
      Returns:
      list of bid enablers
      Throws:
      NullArgumentException - auctionHouseIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionHouseIdsByBidEnabler

      IdList getAuctionHouseIdsByBidEnabler(Id bidEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionHouse Ids mapped to a BidEnabler .
      Parameters:
      bidEnablerId - Id of a BidEnabler
      Returns:
      list of auction house Ids
      Throws:
      NotFoundException - bidEnablerId is not found
      NullArgumentException - bidEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionHousesByBidEnabler

      AuctionHouseList getAuctionHousesByBidEnabler(Id bidEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionHouses mapped to a BidEnabler .
      Parameters:
      bidEnablerId - Id of a BidEnabler
      Returns:
      list of auction houses
      Throws:
      NotFoundException - bidEnablerId is not found
      NullArgumentException - bidEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.