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

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

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAuctionNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedAuctionHouseView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAuctionHouseView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this auction house only.

CompliancemandatoryThis method is must be implemented.
MethodreliableAuctionNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAuctionNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAuctionNotification
Description

Acknowledge an auction notification.

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

Register for notifications of new auctions. AuctionReceiver.newAuctions() is invoked when a new Auction appears in this auction house.

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

Register for notifications of new auctions for the given resource Id. AuctionReceiver.newAuctions() is invoked when a new Auction is created.

Parametersosid.id.IdresourceIdthe Id of the item to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAuctionsForItemGenusType
Description

Register for notifications of new auctions for the given resource genus type. AuctionReceiver.newAuctions() is invoked when a new Auction is created.

Parametersosid.id.IdresourceGenusTypethe genus type of the item to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctions
Description

Registers for notification of updated auctions. AuctionReceiver.changedAuctions() is invoked when an auction in this auction house is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionsForItem
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.

Parametersosid.id.IdresourceIdthe Id of the item to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionsForItemGenusType
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.

Parametersosid.id.IdresourceGenusTypethe genus type of the item to monitor
ErrorsNULL_ARGUMENT resourceGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuction
Description

Registers for notification of an updated auction. AuctionReceiver.changedAuctions() is invoked when the specified auction in this auction house is changed.

Parametersosid.id.IdauctionIdthe Id of the Auction to monitor
ErrorsNULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuctions
Description

Registers for notification of deleted auctions. AuctionReceiver.deletedAuctions() is invoked when an auction is deleted or removed from this auction house.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuctionsForItem
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.

Parametersosid.id.IdresourceIdthe Id of the item to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuctionsForItemGenusType
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.

Parametersosid.id.IdresourceGenusTypethe genus type of the item to monitor
ErrorsNULL_ARGUMENT resourceGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuction
Description

Registers for notification of a deleted auction. AuctionReceiver.deletedAuctions() is invoked when the specified auction is deleted or removed from this auction house.

Parametersosid.id.IdauctionIdthe Id of the Auction to monitor
ErrorsNULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.