OSID - osid.bidding.BidNotificationSession Service Interface Definition

Interface	osid.bidding.BidNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Bid` objects in this `AuctionHouse.` This also includes existing bids that may appear or disappear due to changes in the `AuctionHouse` hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `BidLookupSession.`
Method	getAuctionHouseId
Description	Gets the `AuctionHouse` `Id` associated with this session.
Return	`osid.id.Id`		the `AuctionHouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouse
Description	Gets the `AuctionHouse` associated with this session.
Return	`osid.bidding.AuctionHouse`		the auction house
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForBidNotifications
Description	Tests if this user can register for `Bid` notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedAuctionHouseView
Description	Federates the view for methods in this session. A federated view will include bids in auction houses which are children of this auction house in the auction house hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAuctionHouseView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this auction house only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableBidNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBidNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBidNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBidNotification
Description	Acknowledge a bid notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewBids
Description	Register for notifications of new bids. `BidReceiver.newBids()` is invoked when a new `Bid` appears in this auction house.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewBidsForAuction
Description	Register for notifications of new bids for the given auction `Id.` `BidReceiver.newBids()` is invoked when a new `Bid` is created.
Parameters	`osid.id.Id`	`auctionId`	the `Id` of the auction to monitor
Errors	NULL_ARGUMENT		`auctionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewBidsForBidder
Description	Register for notifications of new bids for the given resource `Id.` `BidReceiver.newBids()` is invoked when a new `Bid` is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBids
Description	Registers for notification of updated bids. `BidReceiver.changedBids()` is invoked when a bid in this auction house is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBidsForAuction
Description	Register for notifications of updated bids for the given auction `Id.` `BidReceiver.changedBids()` is invoked when a `Bid` in this auction house is changed.
Parameters	`osid.id.Id`	`auctionId`	the `Id` of the auction to monitor
Errors	NULL_ARGUMENT		`auctionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBidsForBidder
Description	Register for notifications of updated bids for the given resource `Id.` `BidReceiver.changedBids()` is invoked when a `Bid` in this auction house is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBid
Description	Registers for notification of an updated bid. `BidReceiver.changedBids()` is invoked when the specified bid in this auction house is changed.
Parameters	`osid.id.Id`	`bidId`	the `Id` of the `Bid` to monitor
Errors	NULL_ARGUMENT		`bidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBids
Description	Registers for notification of deleted bids. `BidReceiver.deletedBids()` is invoked when a bid is deleted or removed from this auction house.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBidsForAuction
Description	Register for notifications of deleted bids for the given auction `Id.` `BidReceiver.deletedBids()` is invoked when a `Bid` is deleted or removed from this auction house.
Parameters	`osid.id.Id`	`auctionId`	the `Id` of the auction to monitor
Errors	NULL_ARGUMENT		`auctionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBidsForBidder
Description	Register for notifications of deleted bids for the given resource `Id.` `BidReceiver.deletedBids()` is invoked when a `Bid` is deleted or removed from this auction house.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBid
Description	Registers for notification of a deleted bid. `BidReceiver.deletedBids()` is invoked when the specified bid is deleted or removed from this auction house.
Parameters	`osid.id.Id`	`bidId`	the `Id` of the `Bid` to monitor
Errors	NULL_ARGUMENT		`bidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.