org.osid.bidding.rules

Interface AuctionProcessorEnablerNotificationSession

All Superinterfaces:

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

public interface AuctionProcessorEnablerNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForAuctionProcessorEnablerNotifications() Tests if this user can register for AuctionProcessorEnabler notifications.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
void	registerForChangedAuctionProcessorEnabler(Id auctionProcessorEnablerId) Registers for notification of an updated auction processor enabler.
void	registerForChangedAuctionProcessorEnablers() Registers for notification of updated auction house enablers.
void	registerForDeletedAuctionProcessorEnabler(Id auctionProcessorEnablerId) Registers for notification of a deleted auction processor enabler.
void	registerForDeletedAuctionProcessorEnablers() Registers for notification of deleted auction processor enablers.
void	registerForNewAuctionProcessorEnablers() Register for notifications of new auction processor enablers.
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.

canRegisterForAuctionProcessorEnablerNotifications

boolean canRegisterForAuctionProcessorEnablerNotifications()

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

registerForNewAuctionProcessorEnablers

void registerForNewAuctionProcessorEnablers()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of new auction processor enablers. AuctionProcessorEnablerReceiver.newAuctionProcessorEnabler() is invoked when a new AuctionProcessorEnabler appears in this auction house.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionProcessorEnablers

void registerForChangedAuctionProcessorEnablers()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of updated auction house enablers. AuctionProcessorEnablerReceiver.changedAuctionProcessorEnabler() is invoked when an auction processor enabler in this auction house is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionProcessorEnabler

void registerForChangedAuctionProcessorEnabler(Id auctionProcessorEnablerId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler to monitor

Throws:

NullArgumentException - auctionProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAuctionProcessorEnablers

void registerForDeletedAuctionProcessorEnablers()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of deleted auction processor enablers. AuctionProcessorEnablerReceiver.deletedAuctionProcessorEnabler() is invoked when an auction processor enabler is deleted or removed from this auction house.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAuctionProcessorEnabler

void registerForDeletedAuctionProcessorEnabler(Id auctionProcessorEnablerId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler to monitor

Throws:

NullArgumentException - auctionProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.