public interface DemographicEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to DemographicEnabler
objects in this Bin.
This also includes existing DemographicEnablers
that may
appear or disappear due to changes in the Bin
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
DemographicEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForDemographicEnablerNotifications()
Tests if this user can register for
DemographicEnabler
notifications. |
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
void |
registerForChangedDemographicEnabler(Id demographicEnablerProcessorId)
Registers for notification of an updated demographic enabler.
|
void |
registerForChangedDemographicEnablers()
Registers for notification of updated bin enabelrs.
|
void |
registerForDeletedDemographicEnabler(Id demographicEnablerId)
Registers for notification of a deleted demographic enabler.
|
void |
registerForDeletedDemographicEnablers()
Registers for notification of deleted demographic enablers.
|
void |
registerForNewDemographicEnablers()
Register for notifications of new demographic enablers.
|
void |
useFederatedBinView()
Federates the view for methods in this session.
|
void |
useIsolatedBinView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBinId()
Bin
Id
associated with this
session. Bin Id
associated with this sessionmandatory
- This method must be implemented. Bin getBin() throws OperationFailedException, PermissionDeniedException
Bin
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForDemographicEnablerNotifications()
DemographicEnabler
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 useFederatedBinView()
mandatory
- This method is must be implemented. void useIsolatedBinView()
mandatory
- This method is must be implemented. void registerForNewDemographicEnablers() throws OperationFailedException, PermissionDeniedException
DemographicEnablerReceiver.newDemographicEnablers()
is invoked
when a new DemographicEnabler
appears in this bin.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDemographicEnablers() throws OperationFailedException, PermissionDeniedException
DemographicEnablerReceiver.changedDemographicEnablers()
is
invoked when a demographic enabler in this bin is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDemographicEnabler(Id demographicEnablerProcessorId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedDemographicEnablers()
is invoked
when the specified demographic enabler in this bin is changed.demographicEnablerProcessorId
- the Id
of the
DemographicEnabler
to monitorNullArgumentException
- demographicEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDemographicEnablers() throws OperationFailedException, PermissionDeniedException
DemographicEnablerReceiver.deletedDemographicEnablers()
is
invoked when a demographic enabler is deleted or removed from this
bin.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDemographicEnabler(Id demographicEnablerId) throws OperationFailedException, PermissionDeniedException
DemographicEnablerReceiver.deletedDemographicEnablers()
is
invoked when the specified demographic enabler is deleted or removed
from this bin.demographicEnablerId
- the Id
of the
DemographicEnabler
to monitorNullArgumentException
- demographicEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.