Interface | osid.profile.ProfileItemNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getProfileId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Profile Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfile | ||
Description |
Gets the | ||
Return | osid.profile.Profile | the Profile associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForProfileItemNotifications | ||
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 | useFederatedProfileView | ||
Description |
Federates the view for methods in this session. A federated view will include items in profiles which are children of this profile in the profile hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedProfileView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this profile only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableProfileItemNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableProfileItemNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeProfileItemNotification | ||
Description |
Acknowledge a profile item 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 | registerForNewProfileItems | ||
Description |
Register for notifications of new pofile items. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProfileItems | ||
Description |
Registers for notification of updated profile items.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProfileItem | ||
Description |
Registers for notification of an updated profile item.
| ||
Parameters | osid.id.Id | profileItemId | the Id of the ProfileItem to monitor |
Errors | NULL_ARGUMENT | profileItemId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedProfileItems | ||
Description |
Registers for notification of deleted profile items.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedProfileItem | ||
Description |
Registers for notification of a deleted profile item.
| ||
Parameters | osid.id.Id | profileItemId | the Id of the ProfileItem to monitor |
Errors | NULL_ARGUMENT | profileItemId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |