| Interface | osid.mapping.path.rules.MappingPathRulesManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.mapping.path.rules.MappingPathRulesProfile | |||
| Description |
The mapping rules manager provides access to mapping rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getSpeedZoneEnablerLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SpeedZoneEnablerLookupSession | a SpeedZoneEnablerLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneEnablerLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerLookup()
is true. | |
| Method | getSpeedZoneEnablerLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SpeedZoneEnablerLookupSession | a SpeedZoneEnablerLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerLookup()
and supportsVisibleFederation() are true.
| |
| Method | getSpeedZoneEnablerQuerySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SpeedZoneEnablerQuerySession | a SpeedZoneEnablerQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneEnablerQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerQuery()
is true. | |
| Method | getSpeedZoneEnablerQuerySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SpeedZoneEnablerQuerySession | a SpeedZoneEnablerQuerySession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerQuery()
and supportsVisibleFederation() are true.
| |
| Method | getSpeedZoneEnablerSearchSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SpeedZoneEnablerSearchSession | a SpeedZoneEnablerSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneEnablerSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerSearch()
is true. | |
| Method | getSpeedZoneEnablerSearchSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SpeedZoneEnablerSearchSession | a SpeedZoneEnablerSearchSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerSearch()
and supportsVisibleFederation() are true.
| |
| Method | getSpeedZoneEnablerAdminSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SpeedZoneEnablerAdminSession | a SpeedZoneEnablerAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneEnablerAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerAdmin()
is true. | |
| Method | getSpeedZoneEnablerAdminSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SpeedZoneEnablerAdminSession | a SpeedZoneEnablerAdminSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerAdmin()
and supportsVisibleFederation() are true.
| |
| Method | getSpeedZoneEnablerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.rules.SpeedZoneEnablerReceiver | speedZoneEnablerReceiver | the notification callback |
| Return | osid.mapping.path.rules.SpeedZoneEnablerNotificationSession | a SpeedZoneEnablerNotificationSession | |
| Errors | NULL_ARGUMENT | speedZoneEnablerReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerNotification() is false
| ||
| Compliance | optional | This method must be implemented if
supportsSpeedZoneEnablerNotification() is true. | |
| Method | getSpeedZoneEnablerNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.rules.SpeedZoneEnablerReceiver | speedZoneEnablerReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.rules.SpeedZoneEnablerNotificationSession | a SpeedZoneEnablerNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | speedZoneEnablerReceiver or mapId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsSpeedZoneEnablerNotification() and
supportsVisibleFederation() are true. | |
| Method | getSpeedZoneEnablerMapSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SpeedZoneEnablerMapSession | a SpeedZoneEnablerMapSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneEnablerMap() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneEnablerMap()
is true. | |
| Method | getSpeedZoneEnablerMapAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SpeedZoneEnablerMapAssignmentSession | a SpeedZoneEnablerMapAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneEnablerMapAssignment() is false
| ||
| Compliance | optional | This method must be implemented if
supportsSpeedZoneEnablerMapAssignment() is true. | |
| Method | getSpeedZoneEnablerSmartMapSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SpeedZoneEnablerSmartMapSession | a SpeedZoneEnablerSmartMapSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerSmartMap() is false | ||
| Compliance | optional | This method must be implemented if
supportsSpeedZoneEnablerSmartMap() is true. | |
| Method | getSpeedZoneEnablerRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SpeedZoneEnablerRuleLookupSession | a SpeedZoneEnablerRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneEnablerRuleLookup() is false | ||
| Compliance | optional | This method must be implemented if
supportsSpeedZoneEnablerRuleLookup() is true. | |
| Method | getSpeedZoneEnablerRuleLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SpeedZoneEnablerRuleLookupSession | a SpeedZoneEnablerRuleLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsSpeedZoneEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
| Method | getSpeedZoneEnablerRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSession | a SpeedZoneEnablerRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneEnablerRuleApplication() is false
| ||
| Compliance | optional | This method must be implemented if
supportsSpeedZoneEnablerRuleApplication() is true. | |
| Method | getSpeedZoneEnablerRuleApplicationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSession | a SpeedZoneEnablerRuleApplicationSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsSpeedZoneEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
| Method | getSignalEnablerLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SignalEnablerLookupSession | a SignalEnablerLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalEnablerLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerLookup()
is true. | |
| Method | getSignalEnablerLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SignalEnablerLookupSession | a SignalEnablerLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerLookup()
and supportsVisibleFederation() are true.
| |
| Method | getSignalEnablerQuerySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SignalEnablerQuerySession | a SignalEnablerQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalEnablerQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerQuery()
is true. | |
| Method | getSignalEnablerQuerySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SignalEnablerQuerySession | a SignalEnablerQuerySession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerQuery()
and supportsVisibleFederation() are true.
| |
| Method | getSignalEnablerSearchSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SignalEnablerSearchSession | a SignalEnablerSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalEnablerSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerSearch()
is true. | |
| Method | getSignalEnablerSearchSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SignalEnablerSearchSession | a SignalEnablerSearchSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerSearch()
and supportsVisibleFederation() are true.
| |
| Method | getSignalEnablerAdminSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SignalEnablerAdminSession | a SignalEnablerAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalEnablerAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerAdmin()
is true. | |
| Method | getSignalEnablerAdminSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SignalEnablerAdminSession | a SignalEnablerAdminSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerAdmin()
and supportsVisibleFederation() are true.
| |
| Method | getSignalEnablerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.rules.SignalEnablerReceiver | signalEnablerReceiver | the notification callback |
| Return | osid.mapping.path.rules.SignalEnablerNotificationSession | a SignalEnablerNotificationSession | |
| Errors | NULL_ARGUMENT | signalEnablerReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsSignalEnablerNotification() is true. | |
| Method | getSignalEnablerNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.rules.SignalEnablerReceiver | signalEnablerReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.rules.SignalEnablerNotificationSession | a SignalEnablerNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | signalEnablerReceiver or mapId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsSignalEnablerNotification() and
supportsVisibleFederation() are true. | |
| Method | getSignalEnablerMapSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SignalEnablerMapSession | a SignalEnablerMapSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalEnablerMap() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerMap()
is true. | |
| Method | getSignalEnablerMapAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SignalEnablerMapAssignmentSession | a SignalEnablerMapAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalEnablerMapAssignment() is false | ||
| Compliance | optional | This method must be implemented if
supportsSignalEnablerMapAssignment() is true. | |
| Method | getSignalEnablerSmartMapSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SignalEnablerSmartMapSession | a SignalEnablerSmartMapSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerSmartMap() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerSmartMap()
is true. | |
| Method | getSignalEnablerRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SignalEnablerRuleLookupSession | a SignalEnablerRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalEnablerRuleLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerRuleLookup()
is true. | |
| Method | getSignalEnablerRuleLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SignalEnablerRuleLookupSession | a SignalEnablerRuleLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalEnablerRuleLookup()
and supportsVisibleFederation() are true.
| |
| Method | getSignalEnablerRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.SignalEnablerRuleApplicationSession | a SignalEnablerRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalEnablerRuleApplication() is false
| ||
| Compliance | optional | This method must be implemented if
supportsSignalEnablerRuleApplication() is true. | |
| Method | getSignalEnablerRuleApplicationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.SignalEnablerRuleApplicationSession | a SignalEnablerRuleApplicationSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsSignalEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
| Method | getObstacleEnablerLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.ObstacleEnablerLookupSession | an ObstacleEnablerLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleEnablerLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerLookup()
is true. | |
| Method | getObstacleEnablerLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.ObstacleEnablerLookupSession | an ObstacleEnablerLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerLookup()
and supportsVisibleFederation() are true.
| |
| Method | getObstacleEnablerQuerySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.ObstacleEnablerQuerySession | an ObstacleEnablerQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleEnablerQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerQuery()
is true. | |
| Method | getObstacleEnablerQuerySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.ObstacleEnablerQuerySession | an ObstacleEnablerQuerySession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerQuery()
and supportsVisibleFederation() are true.
| |
| Method | getObstacleEnablerSearchSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.ObstacleEnablerSearchSession | an ObstacleEnablerSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleEnablerSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerSearch()
is true. | |
| Method | getObstacleEnablerSearchSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.ObstacleEnablerSearchSession | an ObstacleEnablerSearchSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerSearch()
and supportsVisibleFederation() are true.
| |
| Method | getObstacleEnablerAdminSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.ObstacleEnablerAdminSession | an ObstacleEnablerAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleEnablerAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerAdmin()
is true. | |
| Method | getObstacleEnablerAdminSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.ObstacleEnablerAdminSession | an ObstacleEnablerAdminSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerAdmin()
and supportsVisibleFederation() are true.
| |
| Method | getObstacleEnablerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.rules.ObstacleEnablerReceiver | obstacleEnablerReceiver | the notification callback |
| Return | osid.mapping.path.rules.ObstacleEnablerNotificationSession | an ObstacleEnablerNotificationSession | |
| Errors | NULL_ARGUMENT | obstacleEnablerReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerNotification() is false
| ||
| Compliance | optional | This method must be implemented if
supportsObstacleEnablerNotification() is true. | |
| Method | getObstacleEnablerNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.rules.ObstacleEnablerReceiver | obstacleEnablerReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.rules.ObstacleEnablerNotificationSession | an ObstacleEnablerNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | obstacleEnablerReceiver or mapId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsObstacleEnablerNotification() and
supportsVisibleFederation() are true. | |
| Method | getObstacleEnablerMapSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.ObstacleEnablerMapSession | an ObstacleEnablerMapSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleEnablerMap() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerMap()
is true. | |
| Method | getObstacleEnablerMapAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.ObstacleEnablerMapAssignmentSession | an ObstacleEnablerMapAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleEnablerMapAssignment() is false
| ||
| Compliance | optional | This method must be implemented if
supportsObstacleEnablerMapAssignment() is true. | |
| Method | getObstacleEnablerSmartMapSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.ObstacleEnablerSmartMapSession | an ObstacleEnablerSmartMapSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerSmartMap() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleEnablerSmartMap()
is true. | |
| Method | getObstacleEnablerRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.ObstacleEnablerRuleLookupSession | an ObstacleEnablerRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleEnablerRuleLookup() is false | ||
| Compliance | optional | This method must be implemented if
supportsObstacleEnablerRuleLookup() is true. | |
| Method | getObstacleEnablerRuleLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.ObstacleEnablerRuleLookupSession | an ObstacleEnablerRuleLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsObstacleEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
| Method | getObstacleEnablerRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.rules.ObstacleEnablerRuleApplicationSession | an ObstacleEnablerRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleEnablerRuleApplication() is false
| ||
| Compliance | optional | This method must be implemented if
supportsObstacleEnablerRuleApplication() is true. | |
| Method | getObstacleEnablerRuleApplicationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.rules.ObstacleEnablerRuleApplicationSession | an ObstacleEnablerRuleApplicationSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsObstacleEnablerRuleApplication() and
supportsVisibleFederation() are true. | |