Interface BiddingManager

All Superinterfaces:

AutoCloseable, BiddingProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface BiddingManager
extends OsidManager, BiddingProfile

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

• MyAuctionSession : a session to look up auctions for authenticated agent
• MyAuctionNotificationSession : a session to receive notifications about an auction in progress for the the authenticated agent
• AuctionLookupSession : a session to retrieve auctions
• AuctionQuerySession : a session to query for auctions
• AuctionSearchSession : a session to search for auctions
• AuctionAdminSession : a session to create and delete auctions
• AuctionNotificationSession : a session to receive notifications pertaining to auction changes
• AuctionAuctionHouseSession : a session to look up auction auction house mappings
• AuctionAuctionHouseAssignmentSession : a session to manage auctions to auction house mappings
• AuctionSmartAuctionHouseSession : a session to manage dynamic auction houses of auctions

• BidLookupSession : a session to retrieve bids
• BidQuerySession : a session to query for bids
• BidSearchSession : a session to search for bids
• BidAdminSession : a session to create and delete bids
• BidNotificationSession : a session to receive notifications pertaining to bid changes
• BidAuctionHouseSession : a session to look up bid auction house mappings
• BidAuctionHouseAssignmentSession : a session to manage bid to auction house mappings
• BidSmartAuctionHouseSession : a session to manage dynamic auction houses of bids

• AuctionHouseLookupSession : a session to retrieve auction houses
• AuctionHouseQuerySession : a session to search for auction houses
• AuctionHouseSearchSession : a session to search for auction houses
• AuctionHouseAdminSession : a session to create and delete auction houses
• AuctionHouseNotificationSession : a session to receive notifications pertaining to auction house changes
• AuctionHouseHierarchySession : a session to traverse a hierarchy of auction house
• AuctionHouseHierarchyDesignSession : a session to manage an auction house hierarchy

Method Summary

Modifier and Type	Method	Description
AuctionAdminSession	getAuctionAdminSession()	Gets the OsidSession associated with the auction administration service.
AuctionAdminSession	getAuctionAdminSessionForAuctionHouse(Id auctionHouseId)	Gets the OsidSession associated with the auction administration service for the given auction house.
AuctionAuctionHouseAssignmentSession	getAuctionAuctionHouseAssignmentSession()	Gets the OsidSession associated with assigning auctions to auction houses.
AuctionAuctionHouseSession	getAuctionAuctionHouseSession()	Gets the OsidSession to lookup auction/auctionHouse mappings.
AuctionHouseAdminSession	getAuctionHouseAdminSession()	Gets the OsidSession associated with the auction house administrative service.
AuctionHouseHierarchyDesignSession	getAuctionHouseHierarchyDesignSession()	Gets the OsidSession associated with the auction house hierarchy design service.
AuctionHouseHierarchySession	getAuctionHouseHierarchySession()	Gets the OsidSession associated with the auction house hierarchy service.
AuctionHouseLookupSession	getAuctionHouseLookupSession()	Gets the OsidSession associated with the auction house lookup service.
AuctionHouseNotificationSession	getAuctionHouseNotificationSession(AuctionHouseReceiver auctionHouseReceiver)	Gets the OsidSession associated with the auction house notification service.
AuctionHouseQuerySession	getAuctionHouseQuerySession()	Gets the OsidSession associated with the auction house query service.
AuctionHouseSearchSession	getAuctionHouseSearchSession()	Gets the OsidSession associated with the auction house search service.
AuctionLookupSession	getAuctionLookupSession()	Gets the OsidSession associated with the auction lookup service.
AuctionLookupSession	getAuctionLookupSessionForAuctionHouse(Id auctionHouseId)	Gets the OsidSession associated with the auction lookup service for the given auction house.
AuctionNotificationSession	getAuctionNotificationSession(AuctionReceiver auctionReceiver)	Gets the OsidSession associated with the auction notification service.
AuctionNotificationSession	getAuctionNotificationSessionForAuctionHouse(AuctionReceiver auctionReceiver, Id auctionHouseId)	Gets the OsidSession associated with the auction notification service for the given auction house.
AuctionQuerySession	getAuctionQuerySession()	Gets the OsidSession associated with the auction query service.
AuctionQuerySession	getAuctionQuerySessionForAuctionHouse(Id auctionHouseId)	Gets the OsidSession associated with the auction query service for the given auction house.
AuctionSearchSession	getAuctionSearchSession()	Gets the OsidSession associated with the auction search service.
AuctionSearchSession	getAuctionSearchSessionForAuctionHouse(Id auctionHouseId)	Gets the OsidSession associated with the auction search service for the given auction house.
AuctionSmartAuctionHouseSession	getAuctionSmartAuctionHouseSession(Id auctionHouseId)	Gets the OsidSession to manage auction smart auction houses.
BidAdminSession	getBidAdminSession()	Gets the OsidSession associated with the bid administrative service.
BidAdminSession	getBidAdminSessionForAuction(Id auctionHouseId)	Gets the OsidSession associated with the bid administrative service for the given auction house.
BidAuctionHouseAssignmentSession	getBidAuctionHouseAssignmentSession()	Gets the OsidSession associated with assigning competencies to auction houses.
BidAuctionHouseSession	getBidAuctionHouseSession()	Gets the OsidSession to lookup bid/auctionHouse mappings.
BiddingBatchManager	getBiddingBatchManager()	Gets a BiddingBatchManager .
BiddingRulesManager	getBiddingRulesManager()	Gets a BiddingRulesManager .
BidLookupSession	getBidLookupSession()	Gets the OsidSession associated with the bid lookup service.
BidLookupSession	getBidLookupSessionForAuctionHouse(Id auctionHouseId)	Gets the OsidSession associated with the bid lookup service for the given auction house.
BidNotificationSession	getBidNotificationSession(BidReceiver bidReceiver)	Gets the OsidSession associated with the bid notification service.
BidNotificationSession	getBidNotificationSessionForAuctionHouse(BidReceiver bidReceiver, Id auctionHouseId)	Gets the OsidSession associated with the bid notification service for the given auction house.
BidQuerySession	getBidQuerySession()	Gets the OsidSession associated with the bid query service.
BidQuerySession	getBidQuerySessionForAuctionHouse(Id auctionHouseId)	Gets the OsidSession associated with the bid query service for the given auction house.
BidSearchSession	getBidSearchSession()	Gets the OsidSession associated with the bid search service.
BidSearchSession	getBidSearchSessionForAuctionHouse(Id auctionHouseId)	Gets the OsidSession associated with the bid search service for the given auction house.
BidSmartAuctionHouseSession	getBidSmartAuctionHouseSession(Id auctionHouseId)	Gets the OsidSession to manage bid smart auction houses.
MyAuctionNotificationSession	getMyAuctionNotificationSession(MyAuctionReceiver myAuctionReceiver)	Gets the OsidSession associated with the my auction notification service.
MyAuctionNotificationSession	getMyAuctionNotificationSessionForAuctionHouse(MyAuctionReceiver myAuctionReceiver, Id auctionHouseId)	Gets the OsidSession associated with the my auction notification service for the given auction house.
MyAuctionSession	getMyAuctionSession()	Gets the OsidSession associated with the my auction service.
MyAuctionSession	getMyAuctionSessionForAuctionHouse(Id auctionHouseId)	Gets the OsidSession associated with the my auction service for the given auction house.

Methods inherited from interface BiddingProfile

getAuctionHouseRecordTypes, getAuctionHouseSearchRecordTypes, getAuctionRecordTypes, getAuctionSearchRecordTypes, getBidRecordTypes, getBidSearchRecordTypes, supportsAuctionAdmin, supportsAuctionAuctionHouse, supportsAuctionAuctionHouseAssignment, supportsAuctionHouseAdmin, supportsAuctionHouseHierarchy, supportsAuctionHouseHierarchyDesign, supportsAuctionHouseLookup, supportsAuctionHouseNotification, supportsAuctionHouseQuery, supportsAuctionHouseRecordType, supportsAuctionHouseSearch, supportsAuctionHouseSearchRecordType, supportsAuctionLookup, supportsAuctionNotification, supportsAuctionQuery, supportsAuctionRecordType, supportsAuctionSearch, supportsAuctionSearchRecordType, supportsAuctionSmartAuctionHouse, supportsBidAdmin, supportsBidAuctionHouse, supportsBidAuctionHouseAssignment, supportsBiddingBatch, supportsBiddingRules, supportsBidLookup, supportsBidNotification, supportsBidQuery, supportsBidRecordType, supportsBidSearch, supportsBidSearchRecordType, supportsBidSmartAuctionHouse, supportsMyAuction, supportsMyAuctionNotification, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getAuctionHouseRecordTypes()	Gets the supported AuctionHouse record types.
TypeList	getAuctionHouseSearchRecordTypes()	Gets the supported AuctionHouse search record types.
TypeList	getAuctionRecordTypes()	Gets the supported Auction record types.
TypeList	getAuctionSearchRecordTypes()	Gets the supported Auction search types.
TypeList	getBidRecordTypes()	Gets the supported Bid record types.
TypeList	getBidSearchRecordTypes()	Gets the supported Bid search record types.
boolean	supportsAuctionAdmin()	Tests if an auction administrative service is supported.
boolean	supportsAuctionAuctionHouse()	Tests if an auction auction house lookup service is supported.
boolean	supportsAuctionAuctionHouseAssignment()	Tests if an auction auction house assignment service is supported.
boolean	supportsAuctionHouseAdmin()	Tests if auction house administrative service is supported.
boolean	supportsAuctionHouseHierarchy()	Tests for the availability of an auction house hierarchy traversal service.
boolean	supportsAuctionHouseHierarchyDesign()	Tests for the availability of an auction house hierarchy design service.
boolean	supportsAuctionHouseLookup()	Tests if looking up auction houses is supported.
boolean	supportsAuctionHouseNotification()	Tests if an auction house notification service is supported.
boolean	supportsAuctionHouseQuery()	Tests if querying auction houses is supported.
boolean	supportsAuctionHouseRecordType(Type auctionHouseRecordType)	Tests if the given AuctionHouse record type is supported.
boolean	supportsAuctionHouseSearch()	Tests if searching auction houses is supported.
boolean	supportsAuctionHouseSearchRecordType(Type auctionHouseSearchRecordType)	Tests if the given AuctionHouse search record type is supported.
boolean	supportsAuctionLookup()	Tests if looking up auctions is supported.
boolean	supportsAuctionNotification()	Tests if an auction notification service is supported.
boolean	supportsAuctionQuery()	Tests if querying auctions is supported.
boolean	supportsAuctionRecordType(Type auctionRecordType)	Tests if the given Auction record type is supported.
boolean	supportsAuctionSearch()	Tests if searching auctions is supported.
boolean	supportsAuctionSearchRecordType(Type auctionSearchRecordType)	Tests if the given Auction search type is supported.
boolean	supportsAuctionSmartAuctionHouse()	Tests if an auction smart auction house service is supported.
boolean	supportsBidAdmin()	Tests if bid administrative service is supported.
boolean	supportsBidAuctionHouse()	Tests if a bid auction house lookup service is supported.
boolean	supportsBidAuctionHouseAssignment()	Tests if a bid auction house service is supported.
boolean	supportsBiddingBatch()	Tests for the availability of a bidding batch service.
boolean	supportsBiddingRules()	Tests for the availability of a bidding rules service.
boolean	supportsBidLookup()	Tests if looking up bids is supported.
boolean	supportsBidNotification()	Tests if a bid notification service is supported.
boolean	supportsBidQuery()	Tests if querying bids is supported.
boolean	supportsBidRecordType(Type bidRecordType)	Tests if the given Bid record type is supported.
boolean	supportsBidSearch()	Tests if searching bids is supported.
boolean	supportsBidSearchRecordType(Type bidSearchRecordType)	Tests if the given Bid search record type is supported.
boolean	supportsBidSmartAuctionHouse()	Tests if a bid smart auction house lookup service is supported.
boolean	supportsMyAuction()	Tests if a my auction service is supported for the current agent.
boolean	supportsMyAuctionNotification()	Tests if a my auction notification service is supported for the current agent.
boolean	supportsVisibleFederation()	Tests if any auction house federation is exposed.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

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

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

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

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 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

getMyAuctionSession

MyAuctionSession getMyAuctionSession()
                              throws OperationFailedException

Gets the OsidSession associated with the my auction service.

Returns:

a MyAuctionSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyAuction() is false

Compliance:

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

getMyAuctionSessionForAuctionHouse

MyAuctionSession getMyAuctionSessionForAuctionHouse(Id auctionHouseId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my auction service for the given auction house.

Parameters:

auctionHouseId - the Id of the auction house

Returns:

a MyAuctionSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyAuction() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMyAuction()} and {@code supportsVisibleFederation()} are {@code true}

getMyAuctionNotificationSession

MyAuctionNotificationSession getMyAuctionNotificationSession(MyAuctionReceiver myAuctionReceiver)
                                                      throws OperationFailedException

Gets the OsidSession associated with the my auction notification service.

Parameters:

myAuctionReceiver - the notification callback

Returns:

a MyAuctionNotificationSession

Throws:

NullArgumentException - myAuctionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyAuctionNotification() is false

Compliance:

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

getMyAuctionNotificationSessionForAuctionHouse

MyAuctionNotificationSession getMyAuctionNotificationSessionForAuctionHouse(MyAuctionReceiver myAuctionReceiver,
 Id auctionHouseId)
                                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my auction notification service for the given auction house.

Parameters:

myAuctionReceiver - the notification callback

auctionHouseId - the Id of the auction house

Returns:

a MyAuctionNotificationSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - myAuctionReceiver or auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyAuctionNotification() is false

Compliance:

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

getAuctionLookupSession

AuctionLookupSession getAuctionLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the auction lookup service.

Returns:

an AuctionLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionLookup() is false

Compliance:

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

getAuctionLookupSessionForAuctionHouse

AuctionLookupSession getAuctionLookupSessionForAuctionHouse(Id auctionHouseId)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the auction lookup service for the given auction house.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

an AuctionLookupSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuctionLookup()} and {@code supportsVisibleFederation()} are {@code true}

getAuctionQuerySession

AuctionQuerySession getAuctionQuerySession()
                                    throws OperationFailedException

Gets the OsidSession associated with the auction query service.

Returns:

an AuctionQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionQuery() is false

Compliance:

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

getAuctionQuerySessionForAuctionHouse

AuctionQuerySession getAuctionQuerySessionForAuctionHouse(Id auctionHouseId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the auction query service for the given auction house.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

an AuctionQuerySession

Throws:

NotFoundException - no auction house found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuctionQuery()} and {@code supportsVisibleFederation()} are {@code true}

getAuctionSearchSession

AuctionSearchSession getAuctionSearchSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the auction search service.

Returns:

an AuctionSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionSearch() is false

Compliance:

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

getAuctionSearchSessionForAuctionHouse

AuctionSearchSession getAuctionSearchSessionForAuctionHouse(Id auctionHouseId)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the auction search service for the given auction house.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

an AuctionSearchSession

Throws:

NotFoundException - no auction house found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuctionSearch()} and {@code supportsVisibleFederation()} are {@code true}

getAuctionAdminSession

AuctionAdminSession getAuctionAdminSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the auction administration service.

Returns:

an AuctionAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionAdmin() is false

Compliance:

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

getAuctionAdminSessionForAuctionHouse

AuctionAdminSession getAuctionAdminSessionForAuctionHouse(Id auctionHouseId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the auction administration service for the given auction house.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

an AuctionAdminSession

Throws:

NotFoundException - no auction house found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuctionAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getAuctionNotificationSession

AuctionNotificationSession getAuctionNotificationSession(AuctionReceiver auctionReceiver)
                                                  throws OperationFailedException

Gets the OsidSession associated with the auction notification service.

Parameters:

auctionReceiver - the notification callback

Returns:

an AuctionNotificationSession

Throws:

NullArgumentException - auctionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionNotification() is false

Compliance:

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

getAuctionNotificationSessionForAuctionHouse

AuctionNotificationSession getAuctionNotificationSessionForAuctionHouse(AuctionReceiver auctionReceiver,
 Id auctionHouseId)
                                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the auction notification service for the given auction house.

Parameters:

auctionReceiver - the notification callback

auctionHouseId - the Id of the AuctionHouse

Returns:

an AuctionNotificationSession

Throws:

NotFoundException - no auction house found by the given Id

NullArgumentException - auctionReceiver or auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuctionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getAuctionAuctionHouseSession

AuctionAuctionHouseSession getAuctionAuctionHouseSession()
                                                  throws OperationFailedException

Gets the OsidSession to lookup auction/auctionHouse mappings.

Returns:

an AuctionAuctionHouseSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionAuctionHouse() is false

Compliance:

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

getAuctionAuctionHouseAssignmentSession

AuctionAuctionHouseAssignmentSession getAuctionAuctionHouseAssignmentSession()
                                                                      throws OperationFailedException

Gets the OsidSession associated with assigning auctions to auction houses.

Returns:

an AuctionAuctionHouseAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionAuctionHouseAssignment() is false

Compliance:

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

getAuctionSmartAuctionHouseSession

AuctionSmartAuctionHouseSession getAuctionSmartAuctionHouseSession(Id auctionHouseId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage auction smart auction houses.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

an AuctionSmartAuctionHouseSession

Throws:

NotFoundException - no auction house found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionSmartAuctionHouse() is false

Compliance:

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

getBidLookupSession

BidLookupSession getBidLookupSession()
                              throws OperationFailedException

Gets the OsidSession associated with the bid lookup service.

Returns:

a BidLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBidLookup() is false

Compliance:

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

getBidLookupSessionForAuctionHouse

BidLookupSession getBidLookupSessionForAuctionHouse(Id auctionHouseId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bid lookup service for the given auction house.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

a BidLookupSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBidLookup()} and {@code supportsVisibleFederation()} are {@code true}

getBidQuerySession

BidQuerySession getBidQuerySession()
                            throws OperationFailedException

Gets the OsidSession associated with the bid query service.

Returns:

a BidQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBidQuery() is false

Compliance:

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

getBidQuerySessionForAuctionHouse

BidQuerySession getBidQuerySessionForAuctionHouse(Id auctionHouseId)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bid query service for the given auction house.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

a CBidQuerySession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBidQuery()} and {@code supportsVisibleFederation()} are {@code true}

getBidSearchSession

BidSearchSession getBidSearchSession()
                              throws OperationFailedException

Gets the OsidSession associated with the bid search service.

Returns:

a BidSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBidSearch() is false

Compliance:

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

getBidSearchSessionForAuctionHouse

BidSearchSession getBidSearchSessionForAuctionHouse(Id auctionHouseId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bid search service for the given auction house.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

a BidSearchSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBidSearch()} and {@code supportsVisibleFederation()} are {@code true}

getBidAdminSession

BidAdminSession getBidAdminSession()
                            throws OperationFailedException

Gets the OsidSession associated with the bid administrative service.

Returns:

a BidAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBidAdmin() is false

Compliance:

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

getBidAdminSessionForAuction

BidAdminSession getBidAdminSessionForAuction(Id auctionHouseId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bid administrative service for the given auction house.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

a BidAdminSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBidAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getBidNotificationSession

BidNotificationSession getBidNotificationSession(BidReceiver bidReceiver)
                                          throws OperationFailedException

Gets the OsidSession associated with the bid notification service.

Parameters:

bidReceiver - the notification callback

Returns:

a BidNotificationSession

Throws:

NullArgumentException - bidReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidNotification() is false

Compliance:

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

getBidNotificationSessionForAuctionHouse

BidNotificationSession getBidNotificationSessionForAuctionHouse(BidReceiver bidReceiver,
 Id auctionHouseId)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bid notification service for the given auction house.

Parameters:

bidReceiver - the notification callback

auctionHouseId - the Id of the AuctionHouse

Returns:

a BidNotificationSession

Throws:

NotFoundException - no auction house found by the given Id

NullArgumentException - bidReceiver or auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBidNotification()} and {@code supportsVisibleFederation()} are {@code true}

getBidAuctionHouseSession

BidAuctionHouseSession getBidAuctionHouseSession()
                                          throws OperationFailedException

Gets the OsidSession to lookup bid/auctionHouse mappings.

Returns:

a BidAuctionHouseSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBidAuctionHouse() is false

Compliance:

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

getBidAuctionHouseAssignmentSession

BidAuctionHouseAssignmentSession getBidAuctionHouseAssignmentSession()
                                                              throws OperationFailedException

Gets the OsidSession associated with assigning competencies to auction houses.

Returns:

a BidyAuctionHouseAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBidAuctionHouseAssignment() is false

Compliance:

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

getBidSmartAuctionHouseSession

BidSmartAuctionHouseSession getBidSmartAuctionHouseSession(Id auctionHouseId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage bid smart auction houses.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

a BidSmartAuctionHouseSession

Throws:

NotFoundException - no AuctionHouse found by the given Id

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBidSmartAuctionHouse() is false

Compliance:

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

getAuctionHouseLookupSession

AuctionHouseLookupSession getAuctionHouseLookupSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the auction house lookup service.

Returns:

an AuctionHouseLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseLookup() is false

Compliance:

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

getAuctionHouseQuerySession

AuctionHouseQuerySession getAuctionHouseQuerySession()
                                              throws OperationFailedException

Gets the OsidSession associated with the auction house query service.

Returns:

an AuctionHouseQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseQuery() is false

Compliance:

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

getAuctionHouseSearchSession

AuctionHouseSearchSession getAuctionHouseSearchSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the auction house search service.

Returns:

an AuctionHouseSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseSearch() is false

Compliance:

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

getAuctionHouseAdminSession

AuctionHouseAdminSession getAuctionHouseAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the auction house administrative service.

Returns:

an AuctionHouseAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseAdmin() is false

Compliance:

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

getAuctionHouseNotificationSession

AuctionHouseNotificationSession getAuctionHouseNotificationSession(AuctionHouseReceiver auctionHouseReceiver)
                                                            throws OperationFailedException

Gets the OsidSession associated with the auction house notification service.

Parameters:

auctionHouseReceiver - the notification callback

Returns:

an AuctionHouseNotificationSession

Throws:

NullArgumentException - auctionHouseReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseNotification() is false

Compliance:

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

getAuctionHouseHierarchySession

AuctionHouseHierarchySession getAuctionHouseHierarchySession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the auction house hierarchy service.

Returns:

an AuctionHouseHierarchySession for auction houses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseHierarchy() is false

Compliance:

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

getAuctionHouseHierarchyDesignSession

AuctionHouseHierarchyDesignSession getAuctionHouseHierarchyDesignSession()
                                                                  throws OperationFailedException

Gets the OsidSession associated with the auction house hierarchy design service.

Returns:

a HierarchyDesignSession for auction houses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuctionHouseHierarchyDesign() is false

Compliance:

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

getBiddingBatchManager

BiddingBatchManager getBiddingBatchManager()
                                    throws OperationFailedException

Gets a BiddingBatchManager .

Returns:

a BiddingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBiddingBatch() is false

Compliance:

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

getBiddingRulesManager

BiddingRulesManager getBiddingRulesManager()
                                    throws OperationFailedException

Gets a BiddingRulesManager .

Returns:

a BiddingRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBiddingRules() is false

Compliance:

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