OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.MapNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Map 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.

MethodcanRegisterForMapNotifications
Description

Tests if this user can register for Map 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableMapNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeMapNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableMapNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeMapNotification
Description

Acknowledge a map notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewMaps
Description

Register for notifications of new maps. MapReceiver.newMaps() is invoked when a new Map is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedMaps
Description

Registers for notification of updated maps. MapReceiver.changedMaps() is invoked when a map is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedMap
Description

Registers for notification of an updated map. MapReceiver.changedMaps() is invoked when the specified map is changed.

Parametersosid.id.IdmapIdthe Id of the Map to monitor
ErrorsNULL_ARGUMENT E
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedMaps
Description

Registers for notification of deleted maps. MapReceiver.deletedMaps() is invoked when a map is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedMap
Description

Registers for notification of a deleted map. MapReceiver.deletedMaps() is invoked when the specified map is deleted.

Parametersosid.id.IdmapIdthe Id of the Map to monitor
ErrorsNULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedMapHierarchy
Description

Registers for notification of an updated map hierarchy structure. MapReceiver.changedChildOfMaps() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedMapHierarchyForAncestors
Description

Registers for notification of an updated map hierarchy structure. MapReceiver.changedChildOfMaps() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdmapIdthe Id of the Map node to monitor
ErrorsNULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedMapHierarchyForDescendants
Description

Registers for notification of an updated map hierarchy structure. MapReceiver.changedChildOfMaps() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdmapIdthe Id of the Map node to monitor
ErrorsNULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.