Interface | osid.bidding.AuctionNotificationSession | ||
---|---|---|---|
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 | canRegisterForAuctionNotifications | ||
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 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 | ||
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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAuctions | ||
Description |
Register for notifications of new auctions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAuctionsForItem | ||
Description |
Register for notifications of new auctions for the
given resource | ||
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. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuctionsForItem | ||
Description |
Register for notifications of updated auctions for the
given item | ||
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. | ||
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.
| ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAuctionsForItem | ||
Description |
Register for notifications of deleted auctions for the
given item | ||
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. | ||
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. | ||
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. |