org.osid.bidding.batch

Interface BiddingBatchManager

All Superinterfaces:

java.lang.AutoCloseable, BiddingBatchProfile, java.io.Closeable, 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 Summary

Methods

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

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                                     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 supportsAuctionBatchAdmin() is 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 supportsAuctionBatchAdmin() and supportsVisibleFederation() are 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 supportsBidBatchAdmin() is 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 supportsBidBatchAdmin() and supportsVisibleFederation() are true

getAuctionHouseBatchAdminSession

AuctionHouseBatchAdminSession getAuctionHouseBatchAdminSession()
                                                               throws OperationFailedException

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

Returns:

a AuctionHouseBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseBatchAdmin() is false

Compliance:

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