Interface AuctionProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve AuctionProcessorEnabler to AuctionProcessor mappings. An AuctionProcessor with multiple AuctionProcessorEnablers means any positive rule evaluation across the enablers result in an effective AuctionProcessor .

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

    • canLookupAuctionProcessorEnablerRules

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

    • useComparativeAuctionProcessorEnablerRuleView

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

    • usePlenaryAuctionProcessorEnablerRuleView

      void usePlenaryAuctionProcessorEnablerRuleView()
      A complete view of the AuctionProcessorEnabler and AuctionProcessor 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 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.

    • getAuctionProcessorEnablerIdsForAuctionProcessor

      IdList getAuctionProcessorEnablerIdsForAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionProcessorEnablerIds associated with an AuctionProcessor .
      Parameters:
      auctionProcessorId - Id of the AuctionProcessor
      Returns:
      the auction processor enabler 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.

    • getAuctionProcessorEnablersForAuctionProcessor

      AuctionProcessorEnablerList getAuctionProcessorEnablersForAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionProcessorEnabler associated with an AuctionProcessor .
      Parameters:
      auctionProcessorId - Id of the AuctionProcessor
      Returns:
      the auction processor enablers
      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.

    • getAuctionProcessorIdsForAuctionProcessorEnabler

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

    • getAuctionProcessorsForAuctionProcessorEnabler

      AuctionProcessorList getAuctionProcessorsForAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionProcessors mapped to an AuctionProcessorEnabler .
      Parameters:
      auctionProcessorEnablerId - Id of an AuctionProcessorEnabler
      Returns:
      list of auction processors
      Throws:
      NotFoundException - auctionProcessorEnablerId is not found
      NullArgumentException - auctionProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.