public interface ProfileEntryEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ProfileEntryEnabler
objects in this Profile.
This also includes existing ProfileEntryEnablers
that may appear or disappear due to changes in the Profile
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
ProfileEntryEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeProfileEntryEnablerNotification(Id notificationId)
Acknowledge a profile entry enabler notification.
|
boolean |
canRegisterForProfileEntryEnablerNotifications()
Tests if this user can register for
ProfileEntryEnabler
notifications. |
Profile |
getProfile()
Gets the
Profile associated with this session. |
Id |
getProfileId()
Gets the
Profile Id associated with this
session. |
void |
registerForChangedProfileEntryEnabler(Id profileEntryEnablerId)
Registers for notification of an updated profile entry enabler.
|
void |
registerForChangedProfileEntryEnablers()
Registers for notification of updated profile enabelrs.
|
void |
registerForDeletedProfileEntryEnabler(Id profileEntryEnablerId)
Registers for notification of a deleted profile entry enabler.
|
void |
registerForDeletedProfileEntryEnablers()
Registers for notification of deleted profile entry enablers.
|
void |
registerForNewProfileEntryEnablers()
Register for notifications of new profile entry enablers.
|
void |
reliableProfileEntryEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableProfileEntryEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedProfileView()
Federates the view for methods in this session.
|
void |
useIsolatedProfileView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getProfileId()
Profile
Id
associated with this
session. Profile Id
associated with this sessionmandatory
- This method must be implemented. Profile getProfile() throws OperationFailedException, PermissionDeniedException
Profile
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForProfileEntryEnablerNotifications()
ProfileEntryEnabler
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 useFederatedProfileView()
mandatory
- This method is must be implemented. void useIsolatedProfileView()
mandatory
- This method is must be implemented. void reliableProfileEntryEnablerNotifications()
acknowledgeProfileEntryEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableProfileEntryEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeProfileEntryEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProfileEntryEnablers() throws OperationFailedException, PermissionDeniedException
ProfileEntryEnablerReceiver.newProfileEntryEnablers()
is
invoked when a new ProfileEntryEnabler
appears in this
profile.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProfileEntryEnablers() throws OperationFailedException, PermissionDeniedException
ProfileEntryEnablerReceiver.changedProfileEntryEnablers()
is
invoked when a profile entry enabler in this profile is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProfileEntryEnabler(Id profileEntryEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedProfileEntryEnablers()
is invoked
when the specified profile entry enabler in this profile is changed.profileEntryEnablerId
- the Id
of the
ProfileEntryEnabler
to monitorNullArgumentException
- profileEntryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProfileEntryEnablers() throws OperationFailedException, PermissionDeniedException
ProfileEntryEnablerReceiver.deletedProfileEntryEnablers()
is
invoked when a profile entry enabler is deleted or removed from this
profile.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProfileEntryEnabler(Id profileEntryEnablerId) throws OperationFailedException, PermissionDeniedException
ProfileEntryEnablerReceiver.deletedProfileEntryEnablers()
is
invoked when the specified profile entry enabler is deleted or removed
from this profile.profileEntryEnablerId
- the Id
of the
ProfileEntryEnabler
to monitorNullArgumentException
- profileEntryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.