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

This session defines methods to receive notifications on changes to an auction in progress.

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.
MethodcanRegisterForMyAuctionNotifications
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.
MethodreliableMyAuctionNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableMyAuctionNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeMyAuctionNotification
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.
MethodregisterForAuctionStart
Description

Register for a notification of the start of the auction. MyAuctionReceiver.startAuctions() is invoked when a the auction begins.

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

Register for notifications of new bids. MyAuctionReceiver.newBids() is invoked when a new Bid is made in this auction.

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

Register for notifications of bids that outbid that of the authenticated bidder. MyAuctionReceiver.outBids() is invoked when a new Bid is made in this auction.

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

Register for notifications of bids that are required at this time for the authenticated bidder. MyAuctionReceiver.requireBid() is invoked when it is time to ante up.

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

Register for a notification of the end of the auction. MyAuctionReceiver.endAuctions() is invoked when a the auction ends.

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