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

Interface	osid.bidding.rules.AuctionProcessorNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `AuctionProcessor` objects in this `AuctionHouse.` This also includes existing `AuctionProcessors` 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 `AuctionProcessorLookupSession.`
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	canRegisterForAuctionProcessorNotifications
Description	Tests if this user can register for `AuctionProcessor` 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 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	reliableAuctionProcessorNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAuctionProcessorNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAuctionProcessorNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAuctionProcessorNotification
Description	Acknowledge an auction processor 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	registerForNewAuctionProcessors
Description	Register for notifications of new auction processors. `AuctionProcessorReceiver.newAuctionProcessors()` is invoked when a new `AuctionProcessor` 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	registerForChangedAuctionProcessors
Description	Registers for notification of updated auction houses. `AuctionProcessorReceiver.changedAuctionProcessors()` is invoked when an auction processor 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	registerForChangedAuctionProcessor
Description	Registers for notification of an updated auction processor. `ProvisionableReceiver.changedAuctionProcessors()` is invoked when the specified auction processor in this auction house is changed.
Parameters	`osid.id.Id`	`auctionProcessorId`	the `Id` of the `AuctionProcessor` to monitor
Errors	NULL_ARGUMENT		`auctionProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAuctionProcessors
Description	Registers for notification of deleted auction processors. `AuctionProcessorReceiver.deletedAuctionProcessors()` is invoked when an auction processor 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	registerForDeletedAuctionProcessor
Description	Registers for notification of a deleted auction processor. `AuctionProcessorReceiver.deletedAuctionProcessors()` is invoked when the specified auction processor is deleted or removed from this auction house.
Parameters	`osid.id.Id`	`auctionProcessorId`	the `Id` of the `AuctionProcessor` to monitor
Errors	NULL_ARGUMENT		`auctionProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.