OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.AuctionHouseNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to AuctionHouse objects. 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.

MethodcanRegisterForAuctionHouseNotifications
Description

Tests if this user can register for AuctionHouse 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableAuctionHouseNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeAuctionHouseNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableAuctionHouseNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAuctionHouseNotification
Description

Acknowledge an auction house notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAuctionHouses
Description

Register for notifications of new auction houses. AuctionHouseReceiver.newAuctionHouses() is invoked when a new AuctionHouse is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionHouses
Description

Registers for notification of updated auction houses. AuctionHouseReceiver.changedAuctionHouses() is invoked when an auction house is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionHouse
Description

Registers for notification of an updated auction house. AuctionHouseReceiver.changedAuctionHouses() is invoked when the specified auction house is changed.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse to monitor
ErrorsNULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuctionHouses
Description

Registers for notification of deleted auction houses. AuctionHouseReceiver.deletedAuctionHouses() is invoked when an auction house is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuctionHouse
Description

Registers for notification of a deleted auction house. AuctionHouseReceiver.deletedAuctionHouses() is invoked when the specified auction house is deleted.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse to monitor
ErrorsNULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionHouseHierarchy
Description

Registers for notification of an updated auction house hierarchy structure. BiddingReceiver.changedChildOfAuctionHouses() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionHouseHierarchyForAncestors
Description

BiddingReceiver.changedChildOfAuctionHouses() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse node to monitor
ErrorsNULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionHouseHierarchyForDescendants
Description

BiddingReceiver.changedChildOfAuctionHouses() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse node to monitor
ErrorsNULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.