Interface BidEnablerRuleLookupSession

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

This session provides methods to retrieve BidEnabler to Bid mappings.

Th is 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
  • isolated auction house view: All methods in this session operate, retrieve and pertain to bid enablers defined explicitly in the current auction house
  • federated auction house view: All methods in this session operate, retrieve and pertain to all bid enablers defined in this auction house and any other bid enablers implicitly available in this auction house through auction house inheritence.

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

    • canLookupBidEnablerRules

      boolean canLookupBidEnablerRules()
      Tests if this user can perform lookups of bid enabler/bid 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 . This 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.

    • useComparativeBidEnablerRuleView

      void useComparativeBidEnablerRuleView()
      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.

    • usePlenaryBidEnablerRuleView

      void usePlenaryBidEnablerRuleView()
      A complete view of the BidEnabler and Bid 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.

    • useFederatedAuctionHouseView

      void useFederatedAuctionHouseView()
      Federates the view for methods in this session. A federated view will include bid enablers in auction houses which are children of this auction house 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.

    • getBidEnablerIdsForBid

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

    • getBidEnablersForBid

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

    • getBidIdsForBidEnabler

      IdList getBidIdsForBidEnabler(Id bidEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Bid Ids mapped to a BidEnabler .
      Parameters:
      bidEnablerId - Id of a BidEnabler
      Returns:
      list of bid 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.

    • getBidsForBidEnabler

      BidList getBidsForBidEnabler(Id bidEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Bids mapped to a BidEnabler .
      Parameters:
      bidEnablerId - Id of a BidEnabler
      Returns:
      list of bids
      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.