Interface | osid.mapping.MapNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForMapNotifications | ||
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 | reliableMapNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableMapNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeMapNotification | ||
Description |
Acknowledge a map 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 | registerForNewMaps | ||
Description |
Register for notifications of new maps. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedMaps | ||
Description |
Registers for notification of updated maps. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedMap | ||
Description |
Registers for notification of an updated map. | ||
Parameters | osid.id.Id | mapId | the Id of the Map to monitor |
Errors | NULL_ARGUMENT | E | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedMaps | ||
Description |
Registers for notification of deleted maps. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedMap | ||
Description |
Registers for notification of a deleted map. | ||
Parameters | osid.id.Id | mapId | the Id of the Map to monitor |
Errors | NULL_ARGUMENT | mapId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedMapHierarchy | ||
Description |
Registers for notification of an updated map hierarchy
structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedMapHierarchyForAncestors | ||
Description |
Registers for notification of an updated map hierarchy
structure. | ||
Parameters | osid.id.Id | mapId | the Id of the Map node to monitor |
Errors | NULL_ARGUMENT | mapId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedMapHierarchyForDescendants | ||
Description |
Registers for notification of an updated map hierarchy
structure. | ||
Parameters | osid.id.Id | mapId | the Id of the Map node to monitor |
Errors | NULL_ARGUMENT | mapId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |