Interface AuctionProcessorRuleLookupSession

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

This session provides methods to retrieve AuctionProcessor to Auction mappings.

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
  • isolated auction house view: All methods in this session operate, retrieve and pertain to auction processors defined explicitly in the current auction house
  • federated auction house view: All methods in this session operate, retrieve and pertain to all auction processors defined in this auction house and any other auction processors 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.

    • canLookupAuctionProcessorRules

      boolean canLookupAuctionProcessorRules()
      Tests if this user can perform lookups of auction processor/auction 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.

    • useComparativeAuctionProcessorRuleView

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

    • usePlenaryAuctionProcessorRuleView

      void usePlenaryAuctionProcessorRuleView()
      A complete view of the AuctionProcessor and Auction 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 auction processor 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.

    • getAuctionProcessorIdsForAuction

      IdList getAuctionProcessorIdsForAuction(Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionProcessor Ids associated with an Auction .
      Parameters:
      auctionId - Id of the Auction
      Returns:
      the auction processor Ids
      Throws:
      NotFoundException - auctionId is not found
      NullArgumentException - auctionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionProcessorsForAuction

      AuctionProcessorList getAuctionProcessorsForAuction(Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionProcessor associated with an Auction .
      Parameters:
      auctionId - Id of the Auction
      Returns:
      the auction processors
      Throws:
      NotFoundException - auctionId is not found
      NullArgumentException - auctionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionIdsForAuctionProcessor

      IdList getAuctionIdsForAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Auction Ids mapped to an AuctionProcessor .
      Parameters:
      auctionProcessorId - Id of an AuctionProcessor
      Returns:
      list of auction Ids
      Throws:
      NotFoundException - auctionProcessorId is not found
      NullArgumentException - auctionProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionsForAuctionProcessor

      AuctionList getAuctionsForAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Auctions mapped to an AuctionProcessor .
      Parameters:
      auctionProcessorId - Id of an AuctionProcessor
      Returns:
      list of auctions
      Throws:
      NotFoundException - auctionProcessorId is not found
      NullArgumentException - auctionProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.