org.osid.bidding.batch

Interface BiddingBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, BiddingBatchProfile, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

public interface BiddingBatchProxyManager
extends OsidProxyManager, BiddingBatchProfile

The bidding batch proxy manager provides access to bidding batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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 Summary

Methods

Modifier and Type	Method and Description
AuctionBatchAdminSession	getAuctionBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk auction administration service.
AuctionBatchAdminSession	getAuctionBatchAdminSessionForAuctionHouse(Id auctionHouseId, Proxy proxy) Gets the OsidSession associated with the bulk auction administration service for the given auction house.
AuctionHouseBatchAdminSession	getAuctionHouseBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk auction house administration service.
BidBatchAdminSession	getBidBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk bid administration service.
BidBatchAdminSession	getBidBatchAdminSessionForAuctionHouse(Id auctionHouseId, Proxy proxy) Gets the OsidSession associated with the bulk bid administration service for the given auction house.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.bidding.batch.BiddingBatchProfile

supportsAuctionBatchAdmin, supportsAuctionHouseBatchAdmin, supportsBidBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAuctionBatchAdminSession

AuctionBatchAdminSession getAuctionBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk auction administration service.

Parameters:

proxy - a proxy

Returns:

an AuctionBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsAuctionBatchAdmin() is true.

getAuctionBatchAdminSessionForAuctionHouse

AuctionBatchAdminSession getAuctionBatchAdminSessionForAuctionHouse(Id auctionHouseId,
                                                                  Proxy proxy)
                                                                    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

proxy - a proxy

Returns:

an AuctionBatchAdminSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuctionBatchAdmin() and supportsVisibleFederation() are true

getBidBatchAdminSession

BidBatchAdminSession getBidBatchAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the bulk bid administration service.

Parameters:

proxy - a proxy

Returns:

a BidBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsBidBatchAdmin() is true.

getBidBatchAdminSessionForAuctionHouse

BidBatchAdminSession getBidBatchAdminSessionForAuctionHouse(Id auctionHouseId,
                                                          Proxy proxy)
                                                            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

proxy - a proxy

Returns:

a BidBatchAdminSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBidBatchAdmin() and supportsVisibleFederation() are true

getAuctionHouseBatchAdminSession

AuctionHouseBatchAdminSession getAuctionHouseBatchAdminSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk auction house administration service.

Parameters:

proxy - a proxy

Returns:

a AuctionHouseBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsAuctionHouseBatchAdmin() is true.