Interface | osid.bidding.AuctionHouseNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForAuctionHouseNotifications | ||
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 | reliableAuctionHouseNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableAuctionHouseNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeAuctionHouseNotification | ||
Description |
Acknowledge an auction house 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 | registerForNewAuctionHouses | ||
Description |
Register for notifications of new auction houses.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuctionHouses | ||
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 | registerForChangedAuctionHouse | ||
Description |
Registers for notification of an updated auction house.
| ||
Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse to monitor |
Errors | NULL_ARGUMENT | auctionHouseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAuctionHouses | ||
Description |
Registers for notification of deleted auction houses.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAuctionHouse | ||
Description |
Registers for notification of a deleted auction house.
| ||
Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse to monitor |
Errors | NULL_ARGUMENT | auctionHouseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuctionHouseHierarchy | ||
Description |
Registers for notification of an updated auction house
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuctionHouseHierarchyForAncestors | ||
Description |
| ||
Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse node to monitor |
Errors | NULL_ARGUMENT | auctionHouseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuctionHouseHierarchyForDescendants | ||
Description |
| ||
Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse node to monitor |
Errors | NULL_ARGUMENT | auctionHouseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |