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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAuctionProcessorEnablerNotification(Id notificationId)
Acknowledge an auction processor enabler notification.
|
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 |
reliableAuctionProcessorEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableAuctionProcessorEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedAuctionHouseView()
Federates the view for methods in this session.
|
void |
useIsolatedAuctionHouseView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAuctionHouseId()
AuctionHouse
Id
associated with
this session. AuctionHouse Id
associated with this
sessionmandatory
- This method must be implemented. AuctionHouse getAuctionHouse() throws OperationFailedException, PermissionDeniedException
AuctionHouse
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAuctionProcessorEnablerNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedAuctionHouseView()
mandatory
- This method is must be implemented. void useIsolatedAuctionHouseView()
mandatory
- This method is must be implemented. void reliableAuctionProcessorEnablerNotifications()
acknowledgeAuctionProcessorEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableAuctionProcessorEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeAuctionProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAuctionProcessorEnablers() throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerReceiver.newAuctionProcessorEnablers()
is invoked when a new AuctionProcessorEnabler
appears
in this auction house.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAuctionProcessorEnablers() throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerReceiver.changedAuctionProcessorEnablers()
is invoked when an auction processor enabler in this auction
house is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedAuctionProcessorEnablers()
is invoked when the specified auction processor enabler in this
auction house is changed.auctionProcessorEnablerId
- the Id
of the
AuctionProcessorEnabler
to monitorNullArgumentException
-
auctionProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAuctionProcessorEnablers() throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerReceiver.deletedAuctionProcessorEnablers()
is invoked when an auction processor enabler is deleted or
removed from this auction house.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerReceiver.deletedAuctionProcessorEnablers()
is invoked when the specified auction processor enabler is
deleted or removed from this auction house.auctionProcessorEnablerId
- the Id
of the
AuctionProcessorEnabler
to monitorNullArgumentException
-
auctionProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.