OSID - osid.bidding.rules.BidEnablerNotificationSession Service Interface Definition

Interface	osid.bidding.rules.BidEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `BidEnablers` in this `AuctionHouse` . This also includes existing bid enablers that may appear or disappear due to changes in the `AuctionHouse h` ierarchy, 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 `BidEnablerLookupSession` .
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	canRegisterForBidEnablerNotifications
Description	Tests if this user can register for `BidEnabler` 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 bid enablers 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	reliableBidEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBidEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBidEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBidEnablerNotification
Description	Acknowledge a bid enabler 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	registerForNewBidEnablers
Description	Register for notifications of new bid enablers. `BidEnablerReceiver.newBidEnablers()` is invoked when a new `BidEnabler` 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	registerForChangedBidEnablers
Description	Register for notifications of updated bid enablers. `BidEnablerReceiver.changedBidEnablers()` is invoked when a `BidEnabler` 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	registerForChangedBidEnabler
Description	Register for notifications of an updated bid enabler. `BidEnablerReceiver.changedBidEnablers()` is invoked when the specified `BidEnabler` in this auction house is changed.
Parameters	`osid.id.Id`	`bidEnablerId`	the `Id` of the `BidEnabler` to monitor
Errors	NULL_ARGUMENT		`bidEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBidEnablers
Description	Registers for notification of deleted bid enablers. `BidEnablerReceiver.deletedBidEnablers()` is invoked when a bid enabler 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	registerForDeletedBidEnabler
Description	Registers for notification of a deleted bid enabler. `BidEnablerReceiver.deletedBidEnabler()` is invoked when the specified bid enabler is deleted or removed from this auction house.
Parameters	`osid.id.Id`	`bidEnablerId`	the `Id` of the `BidEnabler` to monitor
Errors	NULL_ARGUMENT		`bidEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.