Interface | osid.profile.ProfileNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForProfileNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | reliableProfileNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableProfileNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeProfileNotification | ||
Description |
Acknowledge a profile notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewProfiles | ||
Description |
Register for notifications of new profiles. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProfiles | ||
Description |
Registers for notification of updated profiles. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProfile | ||
Description |
Registers for notification of an updated profile.
| ||
Parameters | osid.id.Id | profileId | the Id of the profile to monitor |
Errors | NULL_ARGUMENT | profileId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedProfiles | ||
Description |
Registers for notification of deleted profiles. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedProfile | ||
Description |
Registers for notification of a deleted profile. | ||
Parameters | osid.id.Id | profileId | the Id of the profile to monitor |
Errors | NULL_ARGUMENT | profileId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProfileHierarchy | ||
Description |
Registers for notification of an updated profile
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProfileHierarchyForAncestors | ||
Description |
Registers for notification of an updated profile
hierarchy structure. | ||
Parameters | osid.id.Id | profileId | the Id of the Profile node to monitor |
Errors | NULL_ARGUMENT | profileId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProfileHierarchyForDescendants | ||
Description |
Registers for notification of an updated profile
hierarchy structure. | ||
Parameters | osid.id.Id | profileId | the Id of the Profile node to monitor |
Errors | NULL_ARGUMENT | profileId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |