public interface ProfileNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Profile
objects. 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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeProfileNotification(Id notificationId)
Acknowledge a profile notification.
|
boolean |
canRegisterForProfileNotifications()
Tests if this user can register for
Profile
notifications. |
void |
registerForChangedProfile(Id profileId)
Registers for notification of an updated profile.
|
void |
registerForChangedProfileHierarchy()
Registers for notification of an updated profile hierarchy structure.
|
void |
registerForChangedProfileHierarchyForAncestors(Id profileId)
Registers for notification of an updated profile hierarchy structure.
|
void |
registerForChangedProfileHierarchyForDescendants(Id profileId)
Registers for notification of an updated profile hierarchy structure.
|
void |
registerForChangedProfiles()
Registers for notification of updated profiles.
|
void |
registerForDeletedProfile(Id profileId)
Registers for notification of a deleted profile.
|
void |
registerForDeletedProfiles()
Registers for notification of deleted profiles.
|
void |
registerForNewProfiles()
Register for notifications of new profiles.
|
void |
reliableProfileNotifications()
Reliable notifications are desired.
|
void |
unreliableProfileNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForProfileNotifications()
Profile
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 reliableProfileNotifications()
acknowledgeProfileNotification()
.mandatory
- This method is must be implemented. void unreliableProfileNotifications()
mandatory
- This method is must be implemented. void acknowledgeProfileNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProfiles() throws OperationFailedException, PermissionDeniedException
ProfileReceiver.newProfiles()
is invoked when a new
Profile
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProfiles() throws OperationFailedException, PermissionDeniedException
ProfileReceiver.changedProfiles()
is invoked when a profile is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProfile(Id profileId) throws OperationFailedException, PermissionDeniedException
ProfileReceiver.changedProfiles()
is invoked when the
specified profile is changed.profileId
- the Id of the profile to monitorNullArgumentException
- profileId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProfiles() throws OperationFailedException, PermissionDeniedException
ProfileReceiver.deletedProfiles()
is invoked when a profile is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProfile(Id profileId) throws OperationFailedException, PermissionDeniedException
ProfileReceiver.deletedProfiles()
is invoked when the
specified profile is deleted.profileId
- the Id of the profile to monitorNullArgumentException
- profileId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProfileHierarchy() throws OperationFailedException, PermissionDeniedException
ProfileReceiver.changedChildOfProfiless()
is invoked
when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProfileHierarchyForAncestors(Id profileId) throws OperationFailedException, PermissionDeniedException
ProfileReceiver.changedChildOfProfiles()
is invoked
when the specified node or any of its ancestors experiences a change
in its children.profileId
- the Id
of the Profile
node to monitorNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProfileHierarchyForDescendants(Id profileId) throws OperationFailedException, PermissionDeniedException
ProfileReceiver.changedChildOfProfiles()
is invoked
when the specified node or any of its descendants experiences a change
in its children.profileId
- the Id
of the Profile
node to monitorNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.