Interface AuctionProcessorAuctionHouseSession

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

This session provides methods to retrieve AuctionProcessor to AuctionHouse mappings. An AuctionProcessor 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

    • canLookupAuctionProcessorAuctionHouseMappings

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

    • useComparativeAuctionProcessorAuctionHouseView

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

    • usePlenaryAuctionProcessorAuctionHouseView

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

    • getAuctionProcessorIdsByAuctionHouse

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

    • getAuctionProcessorsByAuctionHouse

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

    • getAuctionProcessorIdsByAuctionHouses

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

    • getAuctionProcessorsByAuctionHouses

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

    • getAuctionHouseIdsByAuctionProcessor

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

    • getAuctionHousesByAuctionProcessor

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