Interface | osid.bidding.rules.AuctionConstrainerNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getAuctionHouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the AuctionHouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionHouse | ||
Description |
Gets the | ||
Return | osid.bidding.AuctionHouse | the auction house | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForAuctionConstrainerNotifications | ||
Description |
Tests if this user can register for | ||
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 | reliableAuctionConstrainerNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableAuctionConstrainerNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeAuctionConstrainerNotification | ||
Description |
Acknowledge an auction constrainer notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAuctionConstrainers | ||
Description |
Register for notifications of new auction constrainers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuctionConstrainers | ||
Description |
Registers for notification of updated auction houses.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuctionConstrainer | ||
Description |
Registers for notification of an updated auction
constrainer. | ||
Parameters | osid.id.Id | auctionConstrainerId | the Id of the AuctionConstrainer to monitor |
Errors | NULL_ARGUMENT | auctionConstrainerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAuctionConstrainers | ||
Description |
Registers for notification of deleted auction
constrainers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAuctionConstrainer | ||
Description |
Registers for notification of a deleted auction
constrainer. | ||
Parameters | osid.id.Id | auctionConstrainerId | the Id of the AuctionConstrainer to monitor |
Errors | NULL_ARGUMENT | auctionConstrainerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |