public interface PriceScheduleNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to PriceSchedule
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.
Notifications are triggered with changes to the PriceSchedule
object itself. Adding and removing orders result in notifications
available from the notification session for orders.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForPriceScheduleNotifications()
Tests if this user can register for
PriceSchedule
notifications. |
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
void |
registerForChangedPriceSchedule(Id priceScheduleId)
Registers for notification of an updated price schedule.
|
void |
registerForChangedPriceSchedules()
Registers for notification of updated price schedules.
|
void |
registerForDeletedPriceSchedule(Id priceScheduleId)
Registers for notification of a deleted price schedule.
|
void |
registerForDeletedPriceSchedules()
Registers for notification of deleted price schedules.
|
void |
registerForNewPriceSchedules()
Register for notifications of new prices.
|
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 canRegisterForPriceScheduleNotifications()
PriceSchedule
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 registerForNewPriceSchedules() throws OperationFailedException, PermissionDeniedException
PriceScheduleReceiver.newPriceSchedules()
is invoked when a
new PriceSchedule
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPriceSchedules() throws OperationFailedException, PermissionDeniedException
PriceScheduleReceiver.changedPriceSchedules()
is invoked when
a price schedule is changed or prices are changed within it.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPriceSchedule(Id priceScheduleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceScheduleReceiver.changedPriceSchedules()
is invoked when
the specified price schedule is changed or prices are changed within
it.priceScheduleId
- the Id
of the
PriceSchedule
to monitorNotFoundException
- a price schedule was not found
identified by the given Id
NullArgumentException
- priceScheduleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPriceSchedules() throws OperationFailedException, PermissionDeniedException
PriceScheduleReceiver.deletedPriceSchedules()
is invoked when
a price schedule is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPriceSchedule(Id priceScheduleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceScheduleReceiver.deletedPriceSchedules()
is invoked when
the specified price schedule is deleted.priceScheduleId
- the Id
of the
PriceSchedule
to monitorNotFoundException
- s price schedule was not found
identified by the given Id
NullArgumentException
- priceScheduleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.