Interface AuctionConstrainerAuctionHouseSession

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

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

    • canLookupAuctionConstrainerAuctionHouseMappings

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

    • useComparativeAuctionConstrainerAuctionHouseView

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

    • usePlenaryAuctionConstrainerAuctionHouseView

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

    • getAuctionConstrainerIdsByAuctionHouse

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

    • getAuctionConstrainersByAuctionHouse

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

    • getAuctionConstrainerIdsByAuctionHouses

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

    • getAuctionConstrainersByAuctionHouses

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

    • getAuctionHouseIdsByAuctionConstrainer

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

    • getAuctionHousesByAuctionConstrainer

      AuctionHouseList getAuctionHousesByAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionHouses mapped to an AuctionConstrainer .
      Parameters:
      auctionConstrainerId - Id of an AuctionConstrainer
      Returns:
      list of auction houses
      Throws:
      NotFoundException - auctionConstrainerId is not found
      NullArgumentException - auctionConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.