Interface BiddingBatchManager

All Superinterfaces:
AutoCloseable, BiddingBatchProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable
public interface BiddingBatchManager extends OsidManager, BiddingBatchProfile

The bidding batch manager provides access to bidding batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • AuctionBatchAdminSession : a session to create, modify and delete auctions in bulk
  • BidBatchSession : a session to create, modify and delete bids in bulk
  • AuctionHouseBatchAdminSession : a session to create, modify and delete auction houses in bulk

  • Method Details

    • getAuctionBatchAdminSession

      AuctionBatchAdminSession getAuctionBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk auction administration service.
      Returns:
      an AuctionBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuctionBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuctionBatchAdmin()} is {@code true} .

    • getAuctionBatchAdminSessionForAuctionHouse

      AuctionBatchAdminSession getAuctionBatchAdminSessionForAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk auction administration service for the given auction house.
      Parameters:
      auctionHouseId - the Id of the AuctionHouse
      Returns:
      an AuctionBatchAdminSession
      Throws:
      NotFoundException - no AuctionHouse found by the given Id
      NullArgumentException - auctionHouseId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuctionBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuctionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getBidBatchAdminSession

      BidBatchAdminSession getBidBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk bid administration service.
      Returns:
      a BidBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBidBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBidBatchAdmin()} is {@code true} .

    • getBidBatchAdminSessionForAuctionHouse

      BidBatchAdminSession getBidBatchAdminSessionForAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk bid administration service for the given auction house.
      Parameters:
      auctionHouseId - the Id of the AuctionHouse
      Returns:
      a BidBatchAdminSession
      Throws:
      NotFoundException - no AuctionHouse found by the given Id
      NullArgumentException - auctionHouseId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBidBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBidBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getAuctionHouseBatchAdminSession

      AuctionHouseBatchAdminSession getAuctionHouseBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk auction house administration service.
      Returns:
      an AuctionHouseBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuctionHouseBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuctionHouseBatchAdmin()} is {@code true} .