Interface | osid.mapping.path.ResourceVelocityNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to resource velocities in this | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForResourcePathNotifications | ||
Description |
Tests if this user can register for 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 | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedMapView | ||
Description |
Federates the view for methods in this session. A federated view will include locations in maps which are children of this map in the map hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedMapView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this map only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForMovingResources | ||
Description |
Registers for notification of moved resources. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForMovingResource | ||
Description |
Registers for notification of moved resources. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForMovingResourcesByGenusType | ||
Description |
Registers for notification of moved resources for the
given resource genus type. | ||
Parameters | osid.type.Type | resourceGenusType | the genus type of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForStoppedResources | ||
Description |
Registers for notification of stopped resources. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForStoppedResource | ||
Description |
Registers for notification of stopped resources. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForStoppedResourcesByGenusType | ||
Description |
Registers for notification of stopped resources for the
given resource genus type. | ||
Parameters | osid.type.Type | resourceGenusType | the genus type of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedResourceVelocities | ||
Description |
Registers for notification of changed resource
velocities. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerFoChangedResourceVelocity | ||
Description |
Registers for notification of moving resources. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedResourceVelocitiesByGenusType | ||
Description |
Registers for notification of moving resources for the
given resource genus type. | ||
Parameters | osid.type.Type | resourceGenusType | the genus type of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |