Interface AuctionProcessorEnablerAuctionHouseSession

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

This session provides methods to retrieve AuctionProcessorEnabler to AuctionHouse mappings. An AuctionProcessorEnabler may appear in multiple AuctionHouse objects. 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

    • canLookupAuctionProcessorEnablerAuctionHouseMappings

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

    • useComparativeAuctionProcessorEnablerAuctionHouseView

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

    • usePlenaryAuctionProcessorEnablerAuctionHouseView

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

    • getAuctionProcessorEnablerIdsByAuctionHouse

      IdList getAuctionProcessorEnablerIdsByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of AuctionProcessorEnablerIds associated with an AuctionHouse .
      Parameters:
      auctionHouseId - Id of the AuctionHouse
      Returns:
      list of related auction processor 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.

    • getAuctionProcessorEnablersByAuctionHouse

      AuctionProcessorEnablerList getAuctionProcessorEnablersByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of auction processor enablers associated with an AuctionHouse .
      Parameters:
      auctionHouseId - Id of the AuctionHouse
      Returns:
      list of related auction processor 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.

    • getAuctionProcessorEnablerIdsByAuctionHouses

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

    • getAuctionProcessorEnablersByAuctionHouses

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

    • getAuctionHouseIdsByAuctionProcessorEnabler

      IdList getAuctionHouseIdsByAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionHouse Ids mapped to an AuctionProcessorEnabler .
      Parameters:
      auctionProcessorEnablerId - Id of an AuctionProcessorEnabler
      Returns:
      list of auction houses
      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.

    • getAuctionHousesByAuctionProcessorEnabler

      AuctionHouseList getAuctionHousesByAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionHouses mapped to an AuctionProcessorEnabler .
      Parameters:
      auctionProcessorEnablerId - Id of an AuctionProcessorEnabler
      Returns:
      list of auction houses
      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.