org.osid.bidding.rules

Interface AuctionProcessorNotificationSession

All Superinterfaces:

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

public interface AuctionProcessorNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to AuctionProcessor objects in this AuctionHouse. This also includes existing AuctionProcessors 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 AuctionProcessorLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeAuctionProcessorNotification(Id notificationId) Acknowledge an auction processor notification.
boolean	canRegisterForAuctionProcessorNotifications() Tests if this user can register for AuctionProcessor notifications.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
void	registerForChangedAuctionProcessor(Id auctionProcessorId) Registers for notification of an updated auction processor.
void	registerForChangedAuctionProcessors() Registers for notification of updated auction houses.
void	registerForDeletedAuctionProcessor(Id auctionProcessorId) Registers for notification of a deleted auction processor.
void	registerForDeletedAuctionProcessors() Registers for notification of deleted auction processors.
void	registerForNewAuctionProcessors() Register for notifications of new auction processors.
void	reliableAuctionProcessorNotifications() Reliable notifications are desired.
void	unreliableAuctionProcessorNotifications() Unreliable notifications are desired.
void	useFederatedAuctionHouseView() Federates the view for methods in this session.
void	useIsolatedAuctionHouseView() Isolates the view for methods in this session.

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.

canRegisterForAuctionProcessorNotifications

boolean canRegisterForAuctionProcessorNotifications()

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

useFederatedAuctionHouseView

void useFederatedAuctionHouseView()

Federates the view for methods in this session. A federated view will include in auction houses which are children of this auction house in the auction house hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedAuctionHouseView

void useIsolatedAuctionHouseView()

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

Compliance:

mandatory - This method is must be implemented.

reliableAuctionProcessorNotifications

void reliableAuctionProcessorNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliableAuctionProcessorNotifications

void unreliableAuctionProcessorNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgeAuctionProcessorNotification

void acknowledgeAuctionProcessorNotification(Id notificationId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Acknowledge an auction processor notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewAuctionProcessors

void registerForNewAuctionProcessors()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Register for notifications of new auction processors. AuctionProcessorReceiver.newAuctionProcessors() is invoked when a new AuctionProcessor appears in this auction house.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionProcessors

void registerForChangedAuctionProcessors()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification of updated auction houses. AuctionProcessorReceiver.changedAuctionProcessors() is invoked when an auction processor in this auction house is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionProcessor

void registerForChangedAuctionProcessor(Id auctionProcessorId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification of an updated auction processor. ProvisionableReceiver.changedAuctionProcessors() is invoked when the specified auction processor in this auction house is changed.

Parameters:

auctionProcessorId - the Id of the AuctionProcessor to monitor

Throws:

NullArgumentException - auctionProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAuctionProcessors

void registerForDeletedAuctionProcessors()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification of deleted auction processors. AuctionProcessorReceiver.deletedAuctionProcessors() is invoked when an auction processor is deleted or removed from this auction house.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAuctionProcessor

void registerForDeletedAuctionProcessor(Id auctionProcessorId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

auctionProcessorId - the Id of the AuctionProcessor to monitor

Throws:

NullArgumentException - auctionProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.