OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.BiddingProxyManager
Implementsosid.OsidProxyManager
osid.bidding.BiddingProfile
Description

The bidding proxy manager provides access to rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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 a auction house hierarchy
MethodgetMyAuctionSession
Description

Gets the OsidSession associated with the my auction service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.MyAuctionSessiona MyAuctionSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyAuction() is false
ComplianceoptionalThis method must be implemented if supportsMyAuction() is true.
MethodgetMyAuctionSessionForAuctionHouse
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the auction house
osid.proxy.Proxyproxya proxy
Returnosid.bidding.MyAuctionSessiona MyAuctionSession
ErrorsNOT_FOUNDno AuctionHouse found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyAuction() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMyAuction() and supportsVisibleFederation() are true
MethodgetMyAuctionNotificationSession
Description

Gets the OsidSession associated with the my auction notification service.

Parametersosid.bidding.MyAuctionReceivermyAuctionReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.bidding.MyAuctionNotificationSessiona MyAuctionNotificationSession
ErrorsNULL_ARGUMENT myAuctionReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyAuctionNotification() is false
ComplianceoptionalThis method must be implemented if supportsMyAuctionNotification() is true
MethodgetMyAuctionNotificationSessionForAuctionHouse
Description

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

Parametersosid.bidding.MyAuctionReceivermyAuctionReceiverthe notification callback
osid.id.IdauctionHouseIdthe Id of the auction house
osid.proxy.Proxyproxya proxy
Returnosid.bidding.MyAuctionNotificationSessiona MyAuctionNotificationSession
ErrorsNOT_FOUNDno AuctionHouse found by the given Id
NULL_ARGUMENT myAuctionReceiver, auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyAuctionNotification() is false
ComplianceoptionalThis method must be implemented if supportsMyAuctionNotification() is true
MethodgetAuctionLookupSession
Description

Gets the OsidSession associated with the auction lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionLookupSessionan AuctionLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionLookup() is false
ComplianceoptionalThis method must be implemented if supportsAuctionLookup() is true.
MethodgetAuctionLookupSessionForAuctionHouse
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionLookupSessionan AuctionLookupSession
ErrorsNOT_FOUNDno AuctionHouse found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuctionLookup() and supportsVisibleFederation() are true
MethodgetAuctionQuerySession
Description

Gets the OsidSession associated with the auction query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionQuerySessionan AuctionQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuctionQuery() is true.
MethodgetAuctionQuerySessionForAuctionHouse
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionQuerySessionan AuctionQuerySession
ErrorsNOT_FOUNDno auction house found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuctionQuery() and supportsVisibleFederation() are true
MethodgetAuctionSearchSession
Description

Gets the OsidSession associated with the auction search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionSearchSessionan AuctionSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionSearch() is false
ComplianceoptionalThis method must be implemented if supportsAuctionSearch() is true.
MethodgetAuctionSearchSessionForAuctionHouse
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionSearchSessionan AuctionSearchSession
ErrorsNOT_FOUNDno auction house found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuctionSearch() and supportsVisibleFederation() are true
MethodgetAuctionAdminSession
Description

Gets the OsidSession associated with the auction administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionAdminSessionan AuctionAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAuctionAdmin() is true.
MethodgetAuctionAdminSessionForAuctionHouse
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionAdminSessionan AuctionAdminSession
ErrorsNOT_FOUNDno auction house found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuctionAdmin() and supportsVisibleFederation() are true
MethodgetAuctionNotificationSession
Description

Gets the OsidSession associated with the auction notification service.

Parametersosid.bidding.AuctionReceiverauctionReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionNotificationSessionan AuctionNotificationSession
ErrorsNULL_ARGUMENT auctionReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionNotification() is false
ComplianceoptionalThis method must be implemented if supportsAuctionNotification() is true.
MethodgetAuctionNotificationSessionForAuctionHouse
Description

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

Parametersosid.bidding.AuctionReceiverauctionReceiverthe notification callback
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionNotificationSessionan AuctionNotificationSession
ErrorsNOT_FOUNDno auction house found by the given Id
NULL_ARGUMENT auctionReceiver, auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuctionNotification() and supportsVisibleFederation() are true
MethodgetAuctionAuctionHouseSession
Description

Gets the OsidSession to lookup auction/auctionHouse mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionAuctionHouseSessionan AuctionAuctionHouseSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionAuctionHouse() is false
ComplianceoptionalThis method must be implemented if supportsAuctionAuctionHouse() is true.
MethodgetAuctionAuctionHouseAssignmentSession
Description

Gets the OsidSession associated with assigning auctions to auction houses.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionAuctionHouseAssignmentSessionan AuctionAuctionHouseAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionAuctionHouseAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAuctionAuctionHouseAssignment() is true.
MethodgetAuctionSmartAuctionHouseSession
Description

Gets the OsidSession to manage auction smart auction houses.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionAuctionHouseSessionan AuctionSmartAuctionHouseSession
ErrorsNOT_FOUNDno auction house found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionSmartAuctionHouse() is false
ComplianceoptionalThis method must be implemented if supportsAuctionSmartAuctionHouse() is true.
MethodgetBidLookupSession
Description

Gets the OsidSession associated with the bid lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.BidLookupSessiona BidLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidLookup() is false
ComplianceoptionalThis method must be implemented if supportsBidLookup() is true.
MethodgetBidLookupSessionForAuctionHouse
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.BidLookupSessiona BidLookupSession
ErrorsNOT_FOUNDno AuctionHouse found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBidLookup() and supportsVisibleFederation() are true
MethodgetBidQuerySession
Description

Gets the OsidSession associated with the bid query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.BidQuerySessiona BidQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidQuery() is false
ComplianceoptionalThis method must be implemented if supportsBidQuery() is true.
MethodgetBidQuerySessionForAuctionHouse
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.BidQuerySessiona BidQuerySession
ErrorsNOT_FOUNDno AuctionHouse found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBidQuery() and supportsVisibleFederation() are true
MethodgetBidSearchSession
Description

Gets the OsidSession associated with the bid search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.BidSearchSessiona BidSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidSearch() is false
ComplianceoptionalThis method must be implemented if supportsBidSearch() is true.
MethodgetBidSearchSessionForAuctionHouse
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.BidSearchSessiona BidSearchSession
ErrorsNOT_FOUNDno AuctionHouse found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBidSearch() and supportsVisibleFederation() are true
MethodgetBidAdminSession
Description

Gets the OsidSession associated with the bid administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.BidAdminSessiona BidAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBidAdmin() is true.
MethodgetBidAdminSessionForAuction
Description

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.BidAdminSessiona BidAdminSession
ErrorsNOT_FOUNDno AuctionHouse found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBidAdmin() and supportsVisibleFederation() are true
MethodgetBidNotificationSession
Description

Gets the OsidSession associated with the bid notification service.

Parametersosid.bidding.BidReceiverbidReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.bidding.BidNotificationSessiona BidNotificationSession
ErrorsNULL_ARGUMENT bidReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidNotification() is false
ComplianceoptionalThis method must be implemented if supportsBidNotification() is true.
MethodgetBidNotificationSessionForAuctionHouse
Description

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

Parametersosid.bidding.BidReceiverbidReceiverthe notification callback
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.BidNotificationSessiona BidNotificationSession
ErrorsNOT_FOUNDno auction house found by the given Id
NULL_ARGUMENT bidReceiver, auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBidNotification() and supportsVisibleFederation() are true
MethodgetBidAuctionHouseSession
Description

Gets the OsidSession to lookup bid/auctionHouse mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.BidAuctionHouseSessiona BidAuctionHouseSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidAuctionHouse() is false
ComplianceoptionalThis method must be implemented if supportsBidyAuctionHouse() is true.
MethodgetBidAuctionHouseAssignmentSession
Description

Gets the OsidSession associated with assigning competencies to auction houses.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.BidAuctionHouseAssignmentSessiona BidyAuctionHouseAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidAuctionHouseAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBidAuctionHouseAssignment() is true.
MethodgetBidSmartAuctionHouseSession
Description

Gets the OsidSession to manage bid smart auction houses.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.proxy.Proxyproxya proxy
Returnosid.bidding.BidSmartAuctionHouseSessiona BidSmartAuctionHouseSession
ErrorsNOT_FOUNDno auction house found by the given Id
NULL_ARGUMENT auctionHouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBidSmartAuctionHouse() is false
ComplianceoptionalThis method must be implemented if supportsBidSmartAuctionHouse() is true.
MethodgetAuctionHouseLookupSession
Description

Gets the OsidSession associated with the auction house lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionHouseLookupSessiona AuctionHouseLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionHouseLookup() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseLookup() is true.
MethodgetAuctionHouseQuerySession
Description

Gets the OsidSession associated with the auction house query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionHouseQuerySessiona AuctionHouseQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionHouseQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseQuery() is true.
MethodgetAuctionHouseSearchSession
Description

Gets the OsidSession associated with the auction house search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionHouseSearchSessiona AuctionHouseSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionHouseSearch() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseSearch() is true.
MethodgetAuctionHouseAdminSession
Description

Gets the OsidSession associated with the auction house administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionHouseAdminSessiona AuctionHouseAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionHouseAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseAdmin() is true.
MethodgetAuctionHouseNotificationSession
Description

Gets the OsidSession associated with the auction house notification service.

Parametersosid.bidding.AuctionHouseReceiverauctionHouseReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionHouseNotificationSessiona AuctionHouseNotificationSession
ErrorsNULL_ARGUMENT auctionHouseReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionHouseNotification() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseNotification() is true.
MethodgetAuctionHouseHierarchySession
Description

Gets the OsidSession associated with the auction house hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionHouseHierarchySessiona AuctionHouseHierarchySession for auction houses
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionHouseHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseHierarchy() is true.
MethodgetAuctionHouseHierarchyDesignSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.bidding.AuctionHouseHierarchyDesignSessiona HierarchyDesignSession for auction houses
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuctionHouseHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseHierarchyDesign() is true.
MethodgetBiddingBatchProxyManager
Description

Gets a BiddingBatchProxyManager.

Returnosid.bidding.batch.BiddingBatchProxyManagera BiddingBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBiddingBatch() is false
ComplianceoptionalThis method must be implemented if supportsBiddingBatch() is true.
MethodgetBiddingRulesProxyManager
Description

Gets a BiddingRulesProxyManager.

Returnosid.bidding.rules.BiddingRulesProxyManagera BiddingRulesProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBiddingRules() is false
ComplianceoptionalThis method must be implemented if supportsBiddingRules() is true.