public interface PriceEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to PriceEnabler
objects in this Store.
This
also includes existing PriceEnablers
that may appear or
disappear due to changes in the Store
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
PriceEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgePriceEnablerNotification(Id notificationId)
Acknowledge a price enabelr notification.
|
boolean |
canRegisterForPriceEnablerNotifications()
Tests if this user can register for
PriceEnabler
notifications. |
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
void |
registerForChangedPriceEnabler(Id priceEnablerId)
Registers for notification of an updated price enabler.
|
void |
registerForChangedPriceEnablers()
Registers for notification of updated store enabelrs.
|
void |
registerForDeletedPriceEnabler(Id priceEnablerId)
Registers for notification of a deleted price enabler.
|
void |
registerForDeletedPriceEnablers()
Registers for notification of deleted price enablers.
|
void |
registerForNewPriceEnablers()
Register for notifications of new price enablers.
|
void |
reliablePriceEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliablePriceEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedStoreView()
Federates the view for methods in this session.
|
void |
useIsolatedStoreView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getStoreId()
Store
Id
associated with this
session. Store Id
associated with this sessionmandatory
- This method must be implemented. Store getStore() throws OperationFailedException, PermissionDeniedException
Store
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForPriceEnablerNotifications()
PriceEnabler
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 useFederatedStoreView()
mandatory
- This method is must be implemented. void useIsolatedStoreView()
mandatory
- This method is must be implemented. void reliablePriceEnablerNotifications()
acknowledgePriceEnablerNotification()
.mandatory
- This method is must be implemented. void unreliablePriceEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgePriceEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPriceEnablers() throws OperationFailedException, PermissionDeniedException
PriceEnablerReceiver.newPriceEnablers()
is invoked when a new
PriceEnabler
appears in this store.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPriceEnablers() throws OperationFailedException, PermissionDeniedException
PriceEnablerReceiver.changedPriceEnablers()
is invoked when a
price enabler in this store is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPriceEnabler(Id priceEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedPriceEnablers()
is invoked when
the specified price enabler in this store is changed.priceEnablerId
- the Id
of the
PriceEnabler
to monitorNullArgumentException
- priceEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPriceEnablers() throws OperationFailedException, PermissionDeniedException
PriceEnablerReceiver.deletedPriceEnablers()
is invoked when a
price enabler is deleted or removed from this store.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPriceEnabler(Id priceEnablerId) throws OperationFailedException, PermissionDeniedException
PriceEnablerReceiver.deletedPriceEnablers()
is invoked when
the specified price enabler is deleted or removed from this store.priceEnablerId
- the Id
of the
PriceEnabler
to monitorNullArgumentException
- priceEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.