public interface PayerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Payer
objects in this Business.
This also
includes existing payers that may appear or disappear due to changes in
the Business
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
PayerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgePayerNotification(Id notificationId)
Acknowledge a payer notification.
|
boolean |
canRegisterForPayerNotifications()
Tests if this user can register for
Payer
notifications. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
void |
registerForChangedPayer(Id payerId)
Registers for notification of an updated payer.
|
void |
registerForChangedPayers()
Registers for notification of updated payers.
|
void |
registerForChangedPayersForResource(Id resourceId)
Registers for notification of updated payers for the given resource.
|
void |
registerForDeletedPayer(Id payerId)
Registers for notification of a deleted payer.
|
void |
registerForDeletedPayers()
Registers for notification of deleted payers.
|
void |
registerForDeletedPayersForResource(Id resourceId)
Registers for notification of deleted payers by the given resource.
|
void |
registerForNewPayers()
Register for notifications of new payers.
|
void |
registerForNewPayersForResource(Id resourceId)
Register for notifications of new payers for the given resource.
|
void |
reliablePayerNotifications()
Reliable notifications are desired.
|
void |
unreliablePayerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForPayerNotifications()
Payer
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 useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. void reliablePayerNotifications()
acknowledgePayerNotification()
.mandatory
- This method is must be implemented. void unreliablePayerNotifications()
mandatory
- This method is must be implemented. void acknowledgePayerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPayers() throws OperationFailedException, PermissionDeniedException
PayerReceiver.newPayers()
is invoked when a new Payer
appears in this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPayersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
PayerReceiver.newPayers()
is invoked when a new
Payer
appears in this business.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPayers() throws OperationFailedException, PermissionDeniedException
PayerReceiver.changedPayers()
is invoked when a payer in this
business is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPayersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
PayerReceiver.changedPayers()
is invoked when the
specified payer in this business is changed.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPayer(Id payerId) throws OperationFailedException, PermissionDeniedException
PayerReceiver.changedPayers()
is invoked when the specified
payer in this business is changed.payerId
- the Id
of the Payer
to
monitorNullArgumentException
- payerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPayers() throws OperationFailedException, PermissionDeniedException
PayerReceiver.deletedPayers()
is invoked when a payer is
deleted or removed from this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPayersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
PayerReceiver.deletedPayers()
is invoked when the
specified payer is deleted or removed from this business.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPayer(Id payerId) throws OperationFailedException, PermissionDeniedException
PayerReceiver.deletedPayers()
is invoked when the specified
payer is deleted or removed from this business.payerId
- the Id
of the Payer
to
monitorNullArgumentException
- payerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.