Interface BiddingBatchProxyManager

All Superinterfaces:

AutoCloseable, BiddingBatchProfile, Closeable, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 BiddingBatchProfile

supportsAuctionBatchAdmin, supportsAuctionHouseBatchAdmin, supportsBidBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAuctionBatchAdmin()	Tests if bulk administration of auctions is available.
boolean	supportsAuctionHouseBatchAdmin()	Tests if bulk administration of auction houses is available.
boolean	supportsBidBatchAdmin()	Tests if bulk administration of bids is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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

getAuctionHouseBatchAdminSession

AuctionHouseBatchAdminSession getAuctionHouseBatchAdminSession(Proxy proxy)
                                                        throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an AuctionHouseBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAuctionHouseBatchAdmin()} is {@code true} .