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 |
---|---|
boolean |
canRegisterForProfileNotifications()
Tests if this user can register for
Profile
notifications. |
void |
registerForChangedProfile(Id profileId)
Registers for notification of an updated profile.
|
void |
registerForChangedProfiles()
Registers for notification of updated profiles.
|
void |
registerForDeletedProfile(Id profileId)
Registers for notification of a deleted profile.
|
void |
registerForDeletedProfileAncestors(Id profileId)
Registers for notification if an ancestor is removed from the
specified profile in the profile hierarchy.
|
void |
registerForDeletedProfileDescendants(Id profileId)
Registers for notification if a descendant is removed from fthe
specified profile in the profile hierarchy.
|
void |
registerForDeletedProfiles()
Registers for notification of deleted profiles.
|
void |
registerForNewProfileAncestors(Id profileId)
Registers for notification if an ancestor is added to the specified
profile in the profile hierarchy.
|
void |
registerForNewProfileDescendants(Id profileId)
Registers for notification if a descendant is added to the specified
profile in the profile hierarchy.
|
void |
registerForNewProfiles()
Register for notifications of new profiles.
|
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 registerForNewProfiles() throws OperationFailedException, PermissionDeniedException
ProfileReceiver.newProfile()
is invoked when a new
Profile
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProfileAncestors(Id profileId) throws OperationFailedException, PermissionDeniedException
ProfileReceiver.newProfileAncestor()
is invoked when the
specified profile experiences an addition in ancestry.profileId
- the Id
of the profile to monitorNullArgumentException
- profileId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProfileDescendants(Id profileId) throws OperationFailedException, PermissionDeniedException
ProfileReceiver.newProfileDescendant()
is invoked when the
specified profile experiences an addition in descendants.profileId
- the Id
of the profile to monitorNullArgumentException
- profileId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProfiles() throws OperationFailedException, PermissionDeniedException
ProfileReceiver.changedProfile()
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.changedProfile()
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.deletedProfile()
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.deletedProfile()
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 registerForDeletedProfileAncestors(Id profileId) throws OperationFailedException, PermissionDeniedException
ProfileReceiver.deletedProfileAncestor()
is invoked when the
specified profile experiences a removal of an ancestor.profileId
- the Id of the profile to monitorNullArgumentException
- profileId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProfileDescendants(Id profileId) throws OperationFailedException, PermissionDeniedException
ProfileReceiver.deletedProfileDescednant()
is invoked when the
specified profile experiences a removal of one of its descendants.profileId
- the Id of the profile to monitorNullArgumentException
- profileId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.