OSID - osid.bidding.AuctionNotificationSession Service Interface Definition

Interface	osid.bidding.AuctionNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.bidding.BiddingManager`
Used By	`osid.bidding.BiddingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Auctions` in this `AuctionHouse`. This also includes existing auctions 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 `AuctionLookupSession`.
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	canRegisterForAuctionNotifications
Description	Tests if this user can register for `Auction` 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 auctions 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	reliableAuctionNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAuctionNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAuctionNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAuctionNotification
Description	Acknowledge an auction 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	registerForNewAuctions
Description	Register for notifications of new auctions. `AuctionReceiver.newAuctions()` is invoked when a new `Auction` 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	registerForNewAuctionsForItem
Description	Register for notifications of new auctions for the given resource `Id`. `AuctionReceiver.newAuctions()` is invoked when a new `Auction` is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the item 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	registerForNewAuctionsForItemGenusType
Description	Register for notifications of new auctions for the given resource genus type. `AuctionReceiver.newAuctions()` is invoked when a new `Auction` is created.
Parameters	`osid.id.Id`	`resourceGenusType`	the genus type of the item 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	registerForChangedAuctions
Description	Registers for notification of updated auctions. `AuctionReceiver.changedAuctions()` is invoked when an auction 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	registerForChangedAuctionsForItem
Description	Register for notifications of updated auctions for the given item `Id`. `AuctionReceiver.changedAuctions()` is invoked when an auction in this auction house is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the item 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	registerForChangedAuctionsForItemGenusType
Description	Register for notifications of updated auctions for the given item genus type. `AuctionReceiver.changedAuctions()` is invoked when an auction in this auction house is changed.
Parameters	`osid.id.Id`	`resourceGenusType`	the genus type of the item to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAuction
Description	Registers for notification of an updated auction. `AuctionReceiver.changedAuctions()` is invoked when the specified auction 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	registerForDeletedAuctions
Description	Registers for notification of deleted auctions. `AuctionReceiver.deletedAuctions()` is invoked when an auction 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	registerForDeletedAuctionsForItem
Description	Register for notifications of deleted auctions for the given item `Id`. `AuctionReceiver.deletedAuctions()` is invoked when an auction in this auction house is removed or deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the item 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	registerForDeletedAuctionsForItemGenusType
Description	Register for notifications of deleted auctions for the given item genus type. `AuctionReceiver.deletedAuctions()` is invoked when an auction in this auction house is removed or deleted.
Parameters	`osid.id.Id`	`resourceGenusType`	the genus type of the item to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAuction
Description	Registers for notification of a deleted auction. `AuctionReceiver.deletedAuctions()` is invoked when the specified auction 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.