Interface | osid.mapping.route.ResourceRouteNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to resources on routes 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 | canRegisterForResourceRouteNotifications | ||
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 | reliableResourceRouteNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableResourceRouteNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeResourceRouteNotification | ||
Description |
Acknowledge a resource route 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 | registerForStartedRoutes | ||
Description |
Register for notifications of new routes for a
resource. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForStartedRoute | ||
Description |
Register for notifications of a started route. | ||
Parameters | osid.id.Id | routeId | the Id of the Route to monitor |
Errors | NULL_ARGUMENT | routeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForStartedRoutesByStartingLocation | ||
Description |
Register for notifications of a started route from the
specified location. | ||
Parameters | osid.id.Id | locationId | the Id of the Location to monitor |
Errors | NULL_ARGUMENT | locationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForStartedRoutesByEndingLocation | ||
Description |
Register for notifications of a started route to the
specified location. | ||
Parameters | osid.id.Id | locationId | the Id of the Location to monitor |
Errors | NULL_ARGUMENT | locationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForStartedRoutesForResource | ||
Description |
Register for notifications of a started route for the
given resource. | ||
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 | registerForStartedRoutesForResourcesByGenusType | ||
Description |
Register for notifications of a started route for
resources of 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 | registerForCompletedRoutes | ||
Description |
Registers for notification of completed routes. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForCompletedRoute | ||
Description |
Register for notifications of a completed route. | ||
Parameters | osid.id.Id | routeId | the Id of the Route to monitor |
Errors | NULL_ARGUMENT | routeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForCompletedRoutesByStartingLocation | ||
Description |
Registers for notification of a completed route from
the specified starting location. | ||
Parameters | osid.id.Id | locationId | the Id of the Location to monitor |
Errors | NULL_ARGUMENT | locationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForCompletedRoutesByEndingLocation | ||
Description |
Registers for notification of a completed route from
the specified ending location. | ||
Parameters | osid.id.Id | locationId | the Id of the Location to monitor |
Errors | NULL_ARGUMENT | locationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForCompletedRoutesForResource | ||
Description |
Registers for notification of a completed route for the
given resource. | ||
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 | registerForCompletedRoutesForResourcesByGenusType | ||
Description |
Registers for notification of a completed route for
resources of 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 | registerForCancelledRoutes | ||
Description |
Registers for notification of cancelled routes. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForCancelledRoute | ||
Description |
Register for notifications of a cancelled route. | ||
Parameters | osid.id.Id | routeId | the Id of the Route to monitor |
Errors | NULL_ARGUMENT | routeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForCancelledRoutesByStartingLocation | ||
Description |
Registers for notification of cancelled routes from the
specified starting location. | ||
Parameters | osid.id.Id | locationId | the Id of the Location to monitor |
Errors | NULL_ARGUMENT | locationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForCancelledRoutesByEndingLocation | ||
Description |
Registers for notification of cancelled routes from the
specified ending location. | ||
Parameters | osid.id.Id | locationId | the Id of the Location to monitor |
Errors | NULL_ARGUMENT | locationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForCancelledRoutesForResource | ||
Description |
Registers for notification of cancelled routes for the
given resource. | ||
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 | registerForCancelledRoutesForResourcesByGenusType | ||
Description |
Registers for notification of cancelled routes for
resources of 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 | registerForNewRouteSegments | ||
Description |
Registers for notification of new route segments.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRouteSegment | ||
Description |
Registers for notification of new route segments.
| ||
Parameters | osid.id.Id | routeSegmentId | the Id of the RouteSegment to monitor |
Errors | NULL_ARGUMENT | routeSegmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRouteSegmentsForResource | ||
Description |
Registers for notification of new route segments for
the given resource. | ||
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 | registerForNewRouteSegmentsForResourcesByGenusType | ||
Description |
Registers for notification of new route segments for
resources of the given 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. |