org.osid.bidding

Interface MyAuctionNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface MyAuctionNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeMyAuctionNotification(Id notificationId) Acknowledge an auction notification.
boolean	canRegisterForMyAuctionNotifications() Tests if this user can register for Auction notifications.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
void	registerForAuctionEnd() Register for a notification of the end of the auction.
void	registerForAuctionStart() Register for a notification of the start of the auction.
void	registerForNewBids() Register for notifications of new bids.
void	registerForOutBids() Register for notifications of bids that outbid that of the authenticated bidder.
void	registerForRequireBid() Register for notifications of bids that are required at this time for the authenticated bidder.
void	reliableMyAuctionNotifications() Reliable notifications are desired.
void	unreliableMyAuctionNotifications() Unreliable notifications are desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAuctionHouseId

Id getAuctionHouseId()

Gets the AuctionHouse Id associated with this session.

Returns:

the AuctionHouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAuctionHouse

AuctionHouse getAuctionHouse()
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets the AuctionHouse associated with this session.

Returns:

the auction house

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForMyAuctionNotifications

boolean canRegisterForMyAuctionNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

reliableMyAuctionNotifications

void reliableMyAuctionNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliableMyAuctionNotifications

void unreliableMyAuctionNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgeMyAuctionNotification

void acknowledgeMyAuctionNotification(Id notificationId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Acknowledge an auction notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForAuctionStart

void registerForAuctionStart()
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBids

void registerForNewBids()
                        throws OperationFailedException,
                               PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForOutBids

void registerForOutBids()
                        throws OperationFailedException,
                               PermissionDeniedException

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.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForRequireBid

void registerForRequireBid()
                           throws OperationFailedException,
                                  PermissionDeniedException

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.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForAuctionEnd

void registerForAuctionEnd()
                           throws OperationFailedException,
                                  PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.