org.osid.bidding

Interface AuctionHouseNotificationSession

All Superinterfaces:

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

public interface AuctionHouseNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeAuctionHouseNotification(Id notificationId) Acknowledge an auction house notification.
boolean	canRegisterForAuctionHouseNotifications() Tests if this user can register for AuctionHouse notifications.
void	registerForChangedAuctionHouse(Id auctionHouseId) Registers for notification of an updated auction house.
void	registerForChangedAuctionHouseHierarchy() Registers for notification of an updated auction house hierarchy structure.
void	registerForChangedAuctionHouseHierarchyForAncestors(Id auctionHouseId) BiddingReceiver.changedChildOfAuctionHouses() is invoked when the specified node or any of its ancestors experiences a change in its children.
void	registerForChangedAuctionHouseHierarchyForDescendants(Id auctionHouseId) BiddingReceiver.changedChildOfAuctionHouses() is invoked when the specified node or any of its descendants experiences a change in its children.
void	registerForChangedAuctionHouses() Registers for notification of updated auction houses.
void	registerForDeletedAuctionHouse(Id auctionHouseId) Registers for notification of a deleted auction house.
void	registerForDeletedAuctionHouses() Registers for notification of deleted auction houses.
void	registerForNewAuctionHouses() Register for notifications of new auction houses.
void	reliableAuctionHouseNotifications() Reliable notifications are desired.
void	unreliableAuctionHouseNotifications() 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

canRegisterForAuctionHouseNotifications

boolean canRegisterForAuctionHouseNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

reliableAuctionHouseNotifications

void reliableAuctionHouseNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliableAuctionHouseNotifications

void unreliableAuctionHouseNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgeAuctionHouseNotification

void acknowledgeAuctionHouseNotification(Id notificationId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Acknowledge an auction house notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewAuctionHouses

void registerForNewAuctionHouses()
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionHouses

void registerForChangedAuctionHouses()
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionHouse

void registerForChangedAuctionHouse(Id auctionHouseId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

auctionHouseId - the Id of the AuctionHouse to monitor

Throws:

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAuctionHouses

void registerForDeletedAuctionHouses()
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAuctionHouse

void registerForDeletedAuctionHouse(Id auctionHouseId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

auctionHouseId - the Id of the AuctionHouse to monitor

Throws:

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionHouseHierarchy

void registerForChangedAuctionHouseHierarchy()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionHouseHierarchyForAncestors

void registerForChangedAuctionHouseHierarchyForAncestors(Id auctionHouseId)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

Parameters:

auctionHouseId - the Id of the AuctionHouse node to monitor

Throws:

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionHouseHierarchyForDescendants

void registerForChangedAuctionHouseHierarchyForDescendants(Id auctionHouseId)
                                                           throws OperationFailedException,
                                                                  PermissionDeniedException

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

Parameters:

auctionHouseId - the Id of the AuctionHouse node to monitor

Throws:

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.