Interface BidEnablerAuctionHouseAssignmentSession

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

This session provides methods to re-assign BidEnabler to AuctionHouse mappings. A BidEnabler may appear in multiple AuctionHouse catalogs and removing the last reference to a BidEnabler is the equivalent of deleting it. Each AuctionHouse may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a BidEnabler to another AuctionHouse is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignBidEnablers

      boolean canAssignBidEnablers()
      Tests if this user can alter bid enabler/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignBidEnablerToAuctionHouse

      boolean canAssignBidEnablerToAuctionHouse(Id auctionHouseId)
      Tests if this user can alter bid enabler/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Parameters:
      auctionHouseId - the Id of the AuctionHouse
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - auctionHouseId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableAuctionHouseIds

      IdList getAssignableAuctionHouseIds(Id auctionHouseId) throws OperationFailedException
      Gets a list of auction houses including and under the given auction house node in which any bid enabler can be assigned.
      Parameters:
      auctionHouseId - the Id of the AuctionHouse
      Returns:
      list of assignable auction house Ids
      Throws:
      NullArgumentException - auctionHouseId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableAuctionHouseIdsForBidEnabler

      IdList getAssignableAuctionHouseIdsForBidEnabler(Id auctionHouseId, Id bidEnablerId) throws OperationFailedException
      Gets a list of auction houses including and under the given auction house node in which a specific bid enabler can be assigned.
      Parameters:
      auctionHouseId - the Id of the AuctionHouse
      bidEnablerId - the Id of the BidEnabler
      Returns:
      list of assignable auction house Ids
      Throws:
      NullArgumentException - auctionHouseId or bidEnablerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignBidEnablerToAuctionHouse

      void assignBidEnablerToAuctionHouse(Id bidEnablerId, Id auctionHouseId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing BidEnabler to an AuctionHouse .
      Parameters:
      bidEnablerId - the Id of the BidEnabler
      auctionHouseId - the Id of the AuctionHouse
      Throws:
      AlreadyExistsException - bidEnablerId is already assigned to auctionHouseId
      NotFoundException - bidEnablerId or auctionHouseId not found
      NullArgumentException - bidEnablerId or auctionHouseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignBidEnablerFromAuctionHouse

      void unassignBidEnablerFromAuctionHouse(Id bidEnablerId, Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a BidEnabler from an AuctionHouse .
      Parameters:
      bidEnablerId - the Id of the BidEnabler
      auctionHouseId - the Id of the AuctionHouse
      Throws:
      NotFoundException - bidEnablerId or auctionHouseId not found or bidEnablerId not assigned to auctionHouseId
      NullArgumentException - bidEnablerId or auctionHouseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignBidEnablerToAuctionHouse

      void reassignBidEnablerToAuctionHouse(Id bidEnablerId, Id fromAuctionHouseId, Id toAuctionHouseId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a BidEnabler from one AuctionHouse to another. Mappings to other AuctionHouses are unaffected.
      Parameters:
      bidEnablerId - the Id of the BidEnabler
      fromAuctionHouseId - the Id of the current AuctionHouse
      toAuctionHouseId - the Id of the destination AuctionHouse
      Throws:
      AlreadyExistsException - bidEnablerId already assigned to toAuctionHouseId
      NotFoundException - bidEnablerId, fromAuctionHouseId , or toAuctionHouseId not found or bidEnablerId not mapped to fromAuctionHouseId
      NullArgumentException - bidEnablerId, fromAuctionHouseId , or toAuctionHouseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.