public interface AvailabilityEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to AvailabilityEnabler
objects in this Foundry.
This also includes existing AvailabilityEnablers
that may appear or disappear due to changes in the Foundry
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
AvailabilityEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForAvailabilityEnablerNotifications()
Tests if this user can register for
AvailabilityEnabler
notifications. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
registerForChangedAvailabilityEnabler(Id availabilityEnablerId)
Registers for notification of an updated availability enabler.
|
void |
registerForChangedAvailabilityEnablers()
Registers for notification of updated foundries.
|
void |
registerForDeletedAvailabilityEnabler(Id availabilityEnablerId)
Registers for notification of a deleted availability enabler.
|
void |
registerForDeletedAvailabilityEnablers()
Registers for notification of deleted availability enablers.
|
void |
registerForNewAvailabilityEnablers()
Register for notifications of new availability enablers.
|
void |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAvailabilityEnablerNotifications()
AvailabilityEnabler
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 useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. void registerForNewAvailabilityEnablers() throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerReceiver.newAvailabilityEnablers()
is
invoked when a new AvailabilityEnabler
appears in this
foundry.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAvailabilityEnablers() throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerReceiver.changedAvailabilityEnablers()
is
invoked when an availability enabler in this foundry is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAvailabilityEnabler(Id availabilityEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedAvailabilityEnablers()
is invoked
when the specified availability enabler in this foundry is changed.availabilityEnablerId
- the Id
of the
AvailabilityEnabler
to monitorNullArgumentException
- availabilityEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAvailabilityEnablers() throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerReceiver.deletedAvailabilityEnablers()
is
invoked when an availability enabler is deleted or removed from this
foundry.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAvailabilityEnabler(Id availabilityEnablerId) throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerReceiver.deletedAvailabilityEnablers()
is
invoked when the specified availability enabler is deleted or removed
from this foundry.availabilityEnablerId
- the Id
of the
AvailabilityEnabler
to monitorNullArgumentException
- availabilityEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.