public interface CommissionEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to CommissionEnabler
objects in this Foundry.
This also includes existing CommissionEnablers
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
CommissionEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForCommissionEnablerNotifications()
Tests if this user can register for
CommissionEnabler
notifications. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
registerForChangedCommissionEnabler(Id commissionEnablerId)
Registers for notification of an updated commission enabler.
|
void |
registerForChangedCommissionEnablers()
Registers for notification of updated foundries.
|
void |
registerForDeletedCommissionEnabler(Id commissionEnablerId)
Registers for notification of a deleted commission enabler.
|
void |
registerForDeletedCommissionEnablers()
Registers for notification of deleted commission enablers.
|
void |
registerForNewCommissionEnablers()
Register for notifications of new commission 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 canRegisterForCommissionEnablerNotifications()
CommissionEnabler
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 registerForNewCommissionEnablers() throws OperationFailedException, PermissionDeniedException
CommissionEnablerReceiver.newCommissionEnablers()
is invoked
when a new CommissionEnabler
appears in this foundry.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommissionEnablers() throws OperationFailedException, PermissionDeniedException
CommissionEnablerReceiver.changedCommissionEnablers()
is
invoked when a commission enabler in this foundry is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommissionEnabler(Id commissionEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedCommissionEnablers()
is invoked
when the specified commission enabler in this foundry is changed.commissionEnablerId
- the Id
of the
CommissionEnabler
to monitorNullArgumentException
- commissionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommissionEnablers() throws OperationFailedException, PermissionDeniedException
CommissionEnablerReceiver.deletedCommissionEnablers()
is
invoked when a commission enabler is deleted or removed from this
foundry.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommissionEnabler(Id commissionEnablerId) throws OperationFailedException, PermissionDeniedException
CommissionEnablerReceiver.deletedCommissionEnablers()
is
invoked when the specified commission enabler is deleted or removed
from this foundry.commissionEnablerId
- the Id
of the
CommissionEnabler
to monitorNullArgumentException
- commissionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.