OSID - osid.bidding.BiddingManager Service Interface Definition

Interface	osid.bidding.BiddingManager
Implements	`osid.OsidManager`
Implements	`osid.bidding.BiddingProfile`
Description	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 a auction house hierarchy
Method	getMyAuctionSession
Description	Gets the `OsidSession` associated with the my auction service.
Return	`osid.bidding.MyAuctionSession`		a `MyAuctionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMyAuction()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMyAuction()` is `true.`
Method	getMyAuctionSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the my auction service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the auction house
Return	`osid.bidding.MyAuctionSession`		a `MyAuctionSession`
Errors	NOT_FOUND		no `AuctionHouse` found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMyAuction()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMyAuction()` and `supportsVisibleFederation()` are `true`
Method	getMyAuctionNotificationSession
Description	Gets the `OsidSession` associated with the my auction notification service.
Parameters	`osid.bidding.MyAuctionReceiver`	`myAuctionReceiver`	the notification callback
Return	`osid.bidding.MyAuctionNotificationSession`		a `MyAuctionNotificationSession`
Errors	NULL_ARGUMENT		`myAuctionReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMyAuctionNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMyAuctionNotification()` is `true`
Method	getMyAuctionNotificationSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the my auction notification service for the given auction house.
Parameters	`osid.bidding.MyAuctionReceiver`	`myAuctionReceiver`	the notification callback
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the auction house
Return	`osid.bidding.MyAuctionNotificationSession`		a `MyAuctionNotificationSession`
Errors	NOT_FOUND		no `AuctionHouse` found by the given `Id`
	NULL_ARGUMENT		`myAuctionReceiver` or `auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMyAuctionNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMyAuctionNotification()` is `true`
Method	getAuctionLookupSession
Description	Gets the `OsidSession` associated with the auction lookup service.
Return	`osid.bidding.AuctionLookupSession`		an `AuctionLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionLookup()` is `true.`
Method	getAuctionLookupSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the auction lookup service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.AuctionLookupSession`		an `AuctionLookupSession`
Errors	NOT_FOUND		no `AuctionHouse` found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAuctionLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionLookup()` and `supportsVisibleFederation()` are `true`
Method	getAuctionQuerySession
Description	Gets the `OsidSession` associated with the auction query service.
Return	`osid.bidding.AuctionQuerySession`		an `AuctionQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionQuery()` is `true.`
Method	getAuctionQuerySessionForAuctionHouse
Description	Gets the `OsidSession` associated with the auction query service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.AuctionQuerySession`		an `AuctionQuerySession`
Errors	NOT_FOUND		no auction house found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAuctionQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionQuery()` and `supportsVisibleFederation()` are `true`
Method	getAuctionSearchSession
Description	Gets the `OsidSession` associated with the auction search service.
Return	`osid.bidding.AuctionSearchSession`		an `AuctionSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionSearch()` is `true.`
Method	getAuctionSearchSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the auction search service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.AuctionSearchSession`		an `AuctionSearchSession`
Errors	NOT_FOUND		no auction house found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAuctionSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionSearch()` and `supportsVisibleFederation()` are `true`
Method	getAuctionAdminSession
Description	Gets the `OsidSession` associated with the auction administration service.
Return	`osid.bidding.AuctionAdminSession`		an `AuctionAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionAdmin()` is `true.`
Method	getAuctionAdminSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the auction administration service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.AuctionAdminSession`		an `AuctionAdminSession`
Errors	NOT_FOUND		no auction house found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAuctionAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionAdmin()` and `supportsVisibleFederation()` are `true`
Method	getAuctionNotificationSession
Description	Gets the `OsidSession` associated with the auction notification service.
Parameters	`osid.bidding.AuctionReceiver`	`auctionReceiver`	the notification callback
Return	`osid.bidding.AuctionNotificationSession`		an `AuctionNotificationSession`
Errors	NULL_ARGUMENT		`auctionReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAuctionNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionNotification()` is `true.`
Method	getAuctionNotificationSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the auction notification service for the given auction house.
Parameters	`osid.bidding.AuctionReceiver`	`auctionReceiver`	the notification callback
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.AuctionNotificationSession`		an `AuctionNotificationSession`
Errors	NOT_FOUND		no auction house found by the given `Id`
	NULL_ARGUMENT		`auctionReceiver` or `auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAuctionNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionNotification()` and `supportsVisibleFederation()` are `true`
Method	getAuctionAuctionHouseSession
Description	Gets the `OsidSession` to lookup auction/auctionHouse mappings.
Return	`osid.bidding.AuctionAuctionHouseSession`		an `AuctionAuctionHouseSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionAuctionHouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionAuctionHouse()` is `true.`
Method	getAuctionAuctionHouseAssignmentSession
Description	Gets the `OsidSession` associated with assigning auctions to auction houses.
Return	`osid.bidding.AuctionAuctionHouseAssignmentSession`		an `AuctionAuctionHouseAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionAuctionHouseAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionAuctionHouseAssignment()` is `true.`
Method	getAuctionSmartAuctionHouseSession
Description	Gets the `OsidSession` to manage auction smart auction houses.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.AuctionAuctionHouseSession`		an `AuctionSmartAuctionHouseSession`
Errors	NOT_FOUND		no auction house found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAuctionSmartAuctionHouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionSmartAuctionHouse()` is `true.`
Method	getBidLookupSession
Description	Gets the `OsidSession` associated with the bid lookup service.
Return	`osid.bidding.BidLookupSession`		a `BidLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBidLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidLookup()` is `true.`
Method	getBidLookupSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the bid lookup service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.BidLookupSession`		a `BidLookupSession`
Errors	NOT_FOUND		no `AuctionHouse` found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBidLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidLookup()` and `supportsVisibleFederation()` are `true`
Method	getBidQuerySession
Description	Gets the `OsidSession` associated with the bid query service.
Return	`osid.bidding.BidQuerySession`		a `BidQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBidQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidQuery()` is `true.`
Method	getBidQuerySessionForAuctionHouse
Description	Gets the `OsidSession` associated with the bid query service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.BidQuerySession`		a `CBidQuerySession`
Errors	NOT_FOUND		no `AuctionHouse` found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBidQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidQuery()` and `supportsVisibleFederation()` are `true`
Method	getBidSearchSession
Description	Gets the `OsidSession` associated with the bid search service.
Return	`osid.bidding.BidSearchSession`		a `BidSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBidSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidSearch()` is `true.`
Method	getBidSearchSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the bid search service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.BidSearchSession`		a `BidSearchSession`
Errors	NOT_FOUND		no `AuctionHouse` found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBidSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidSearch()` and `supportsVisibleFederation()` are `true`
Method	getBidAdminSession
Description	Gets the `OsidSession` associated with the bid administrative service.
Return	`osid.bidding.BidAdminSession`		a `BidAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBidAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidAdmin()` is `true.`
Method	getBidAdminSessionForAuction
Description	Gets the `OsidSession` associated with the bid administrative service for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.BidAdminSession`		a `BidAdminSession`
Errors	NOT_FOUND		no `AuctionHouse` found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBidAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidAdmin()` and `supportsVisibleFederation()` are `true`
Method	getBidNotificationSession
Description	Gets the `OsidSession` associated with the bid notification service.
Parameters	`osid.bidding.BidReceiver`	`bidReceiver`	the notification callback
Return	`osid.bidding.BidNotificationSession`		a `BidNotificationSession`
Errors	NULL_ARGUMENT		`bidReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBidNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidNotification()` is `true.`
Method	getBidNotificationSessionForAuctionHouse
Description	Gets the `OsidSession` associated with the bid notification service for the given auction house.
Parameters	`osid.bidding.BidReceiver`	`bidReceiver`	the notification callback
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.BidNotificationSession`		a `BidNotificationSession`
Errors	NOT_FOUND		no auction house found by the given `Id`
	NULL_ARGUMENT		`bidReceiver` or `auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBidNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidNotification()` and `supportsVisibleFederation()` are `true`
Method	getBidAuctionHouseSession
Description	Gets the `OsidSession` to lookup bid/auctionHouse mappings.
Return	`osid.bidding.BidAuctionHouseSession`		a `BidAuctionHouseSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBidAuctionHouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidyAuctionHouse()` is `true.`
Method	getBidAuctionHouseAssignmentSession
Description	Gets the `OsidSession` associated with assigning competencies to auction houses.
Return	`osid.bidding.BidAuctionHouseAssignmentSession`		a `BidyAuctionHouseAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBidAuctionHouseAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidAuctionHouseAssignment()` is `true.`
Method	getBidSmartAuctionHouseSession
Description	Gets the `OsidSession` to manage bid smart auction houses.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.BidSmartAuctionHouseSession`		a `BidSmartAuctionHouseSession`
Errors	NOT_FOUND		no `AuctionHouse` found by the given `Id`
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBidSmartAuctionHouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidSmartAuctionHouse()` is `true.`
Method	getAuctionHouseLookupSession
Description	Gets the `OsidSession` associated with the auction house lookup service.
Return	`osid.bidding.AuctionHouseLookupSession`		a `AuctionHouseLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionHouseLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionHouseLookup()` is `true.`
Method	getAuctionHouseQuerySession
Description	Gets the `OsidSession` associated with the auction house query service.
Return	`osid.bidding.AuctionHouseQuerySession`		a `AuctionHouseQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionHouseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionHouseQuery()` is `true.`
Method	getAuctionHouseSearchSession
Description	Gets the `OsidSession` associated with the auction house search service.
Return	`osid.bidding.AuctionHouseSearchSession`		a `AuctionHouseSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionHouseSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionHouseSearch()` is `true.`
Method	getAuctionHouseAdminSession
Description	Gets the `OsidSession` associated with the auction house administrative service.
Return	`osid.bidding.AuctionHouseAdminSession`		a `AuctionHouseAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionHouseAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionHouseAdmin()` is `true.`
Method	getAuctionHouseNotificationSession
Description	Gets the `OsidSession` associated with the auction house notification service.
Parameters	`osid.bidding.AuctionHouseReceiver`	`auctionHouseReceiver`	the notification callback
Return	`osid.bidding.AuctionHouseNotificationSession`		a `AuctionHouseNotificationSession`
Errors	NULL_ARGUMENT		`auctionHouseReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAuctionHouseNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionHouseNotification()` is `true.`
Method	getAuctionHouseHierarchySession
Description	Gets the `OsidSession` associated with the auction house hierarchy service.
Return	`osid.bidding.AuctionHouseHierarchySession`		a `AuctionHouseHierarchySession` for auction houses
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionHouseHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionHouseHierarchy()` is `true.`
Method	getAuctionHouseHierarchyDesignSession
Description	Gets the `OsidSession` associated with the auction house hierarchy design service.
Return	`osid.bidding.AuctionHouseHierarchyDesignSession`		a `HierarchyDesignSession` for auction houses
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuctionHouseHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionHouseHierarchyDesign()` is `true.`
Method	getBiddingBatchManager
Description	Gets a `BiddingBatchManager.`
Return	`osid.bidding.batch.BiddingBatchManager`		a `BiddingBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBiddingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBiddingBatch()` is `true.`
Method	getBiddingRulesManager
Description	Gets a `BiddingRulesManager.`
Return	`osid.bidding.rules.BiddingRulesManager`		a `BiddingRulesManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBiddingRules()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBiddingRules()` is `true.`