OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Interfaceosid.mapping.path.rules.MappingPathRulesProxyManager
Implementsosid.OsidProxyManager
osid.mapping.path.rules.MappingPathRulesProfile
Used Byosid.mapping.path.MappingPathProxyManager
Description

The mapping rules proxy manager provides access to mapping rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

  • SpeedZoneEnablerLookupSession : a session to retrieve speed zone enablers
  • SpeedZoneEnablerQuerySession : a session to query for speed zone enablers
  • SpeedZoneEnablerSearchSession : a session to search for speed zone enablers
  • SpeedZoneEnablerAdminSession : a session to create and delete speed zone enablers
  • SpeedZoneEnablerNotificationSession : a session to receive notifications pertaining to speed zone enabler changes
  • SpeedZoneEnablerMapSession : a session to look up speed zone enabler map mappings
  • SpeedZoneEnablerMapAssignmentSession : a session to manage speed zone enabler to map mappings
  • SpeedZoneEnablerSmartMapSession : a session to manage dynamic map of speed zone enablers
  • SpeedZoneEnableRuleLookupSession : a session to look up speed zone enabler mappings
  • SpeedZoneEnablerRuleApplicationSession : a session to apply speed zone enablers
  • SpeedZoneProcessorEnablerLookupSession : a session to retrieve speed zone processor enablers
  • SpeedZoneProcessorEnablerQuerySession : a session to query for speed zone processor enablers
  • SpeedZoneProcessorEnablerSearchSession : a session to search for speed zone processor enablers
  • SpeedZoneProcessorEnablerAdminSession : a session to create and delete speed zone processor enablers
  • SpeedZoneProcessorEnablerNotificationSession : a session to receive notifications pertaining to speed zone processor enabler changes
  • SpeedZoneProcessorEnablerMapSession : a session to look up speed zone processor enabler map mappings
  • SpeedZoneProcessorEnablerMapAssignmentSession : a session to manage speed zone processor enabler to map mappings
  • SpeedZoneProcessorEnablerSmartMapSession : a session to manage dynamic map of speed zone processor enablers
  • SpeedZoneProcessorEnablerRuleLookupSession : a session to look up speed zone processor enabler mappings
  • SpeedZoneProcessorEnablerRuleApplicationSession : a session to apply speed zone processor enablers
  • SignalEnablerLookupSession : a session to retrieve signal enabler
  • SignalEnablerQuerySession : a session to query for signal enabler
  • SignalEnablerSearchSession : a session to search for signal enabler
  • SignalEnablerAdminSession : a session to create and delete signal enabler
  • SignalEnablerNotificationSession : a session to receive notifications pertaining to signal enabler changes
  • SignalEnablerMapSession : a session to look up signal enabler map mappings
  • SignalEnablerMapAssignmentSession : a session to manage signal enabler to map mappings
  • SignalEnablerSmartMapSession : a session to manage dynamic map of signal enabler
  • SignalEnablerRuleLookupSession : a session to look up signal enabler to signal mappings
  • SignalEnablerRuleApplicationSession : a session to apply signal enabler to signalss
  • ObstacleEnablerLookupSession : a session to retrieve obstacle enabler
  • ObstacleEnablerQuerySession : a session to query for obstacle enabler
  • ObstacleEnablerSearchSession : a session to search for obstacle enabler
  • ObstacleEnablerAdminSession : a session to create and delete obstacle enabler
  • ObstacleEnablerNotificationSession : a session to receive notifications pertaining to obstacle enabler changes
  • ObstacleEnablerMapSession : a session to look up obstacle enabler map mappings
  • ObstacleEnablerMapAssignmentSession : a session to manage obstacle enabler to map mappings
  • ObstacleEnablerSmartMapSession : a session to manage dynamic map of obstacle enabler
  • ObstacleEnablerRuleLookupSession : a session to look up obstacle enabler to obstacle mappings
  • ObstacleEnablerRuleApplicationSession : a session to apply obstacle enabler to obstacles
MethodgetSpeedZoneEnablerLookupSession
Description

Gets the OsidSession associated with the speed zone enabler lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerLookupSessiona SpeedZoneEnablerLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerLookup() is true .
MethodgetSpeedZoneEnablerLookupSessionForMap
Description

Gets the OsidSession associated with the speed zone enabler lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerLookupSessiona SpeedZoneEnablerLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerLookup() and supportsVisibleFederation() are true .
MethodgetSpeedZoneEnablerQuerySession
Description

Gets the OsidSession associated with the speed zone enabler query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerQuerySessiona SpeedZoneEnablerQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerQuery() is true .
MethodgetSpeedZoneEnablerQuerySessionForMap
Description

Gets the OsidSession associated with the speed zone enabler query service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerQuerySessiona SpeedZoneEnablerQuerySession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerQuery() and supportsVisibleFederation() are true .
MethodgetSpeedZoneEnablerSearchSession
Description

Gets the OsidSession associated with the speed zone enabler search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerSearchSessiona SpeedZoneEnablerSearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerSearch() is true .
MethodgetSpeedZoneEnablerSearchSessionForMap
Description

Gets the OsidSession associated with the speed zone enablers earch service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerSearchSessiona SpeedZoneEnablerSearchSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerSearch() and supportsVisibleFederation() are true .
MethodgetSpeedZoneEnablerAdminSession
Description

Gets the OsidSession associated with the speed zone enabler administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerAdminSessiona SpeedZoneEnablerAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerAdmin() is true .
MethodgetSpeedZoneEnablerAdminSessionForMap
Description

Gets the OsidSession associated with the speed zone enabler administration service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerAdminSessiona SpeedZoneEnablerAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetSpeedZoneEnablerNotificationSession
Description

Gets the OsidSession associated with the speed zone enabler notification service.

Parametersosid.mapping.path.rules.SpeedZoneEnablerReceiverspeedZoneEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerNotificationSessiona SpeedZoneEnablerNotificationSession
ErrorsNULL_ARGUMENTspeedZoneEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerNotification() is true .
MethodgetSpeedZoneEnablerNotificationSessionForMap
Description

Gets the OsidSession associated with the speed zone enabler notification service for the given map.

Parametersosid.mapping.path.rules.SpeedZoneEnablerReceiverspeedZoneEnablerReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerNotificationSessiona SpeedZoneEnablerNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENTspeedZoneEnablerReceiver, mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerNotification() and supportsVisibleFederation() are true .
MethodgetSpeedZoneEnablerMapSession
Description

Gets the OsidSession to lookup speed zone enabler/map mappings for speed zone enablers.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerMapSessiona SpeedZoneEnablerMapSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerMap() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerMap() is true .
MethodgetSpeedZoneEnablerMapAssignmentSession
Description

Gets the OsidSession associated with assigning speed zone enablers to map.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerMapAssignmentSessiona SpeedZoneEnablerMapAssignmentSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerMapAssignment() is true .
MethodgetSpeedZoneEnablerSmartMapSession
Description

Gets the OsidSession to manage speed zone enabler smart map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerSmartMapSessiona SpeedZoneEnablerSmartMapSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerSmartMap() is true .
MethodgetSpeedZoneEnablerRuleLookupSession
Description

Gets the OsidSession associated with the speed zone enabler mapping lookup service .

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerRuleLookupSessiona SpeedZoneEnablerRuleLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerRuleLookup() is true .
MethodgetSpeedZoneEnablerRuleLookupSessionForMap
Description

Gets the OsidSession associated with the speed zone enabler mapping lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerRuleLookupSessiona SpeedZoneEnablerRuleLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetSpeedZoneEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the speed zone enabler assignment service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSessiona SpeedZoneEnablerRuleApplicationSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerRuleApplication() is true .
MethodgetSpeedZoneEnablerRuleApplicationSessionForMap
Description

Gets the OsidSession associated with the speed zone enabler assignment service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSessiona SpeedZoneEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSpeedZoneEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetSignalEnablerLookupSession
Description

Gets the OsidSession associated with the signal enabler lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerLookupSessiona SignalEnablerLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerLookup() is true .
MethodgetSignalEnablerLookupSessionForMap
Description

Gets the OsidSession associated with the signal enabler lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerLookupSessiona SignalEnablerLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerLookup() and supportsVisibleFederation() are true .
MethodgetSignalEnablerQuerySession
Description

Gets the OsidSession associated with the signal enabler query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerQuerySessiona SignalEnablerQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerQuery() is true .
MethodgetSignalEnablerQuerySessionForMap
Description

Gets the OsidSession associated with the signal enabler query service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerQuerySessiona SignalEnablerQuerySession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerQuery() and supportsVisibleFederation() are true .
MethodgetSignalEnablerSearchSession
Description

Gets the OsidSession associated with the signal enabler search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerSearchSessiona SignalEnablerSearchSession
ErrorsNULL_ARGUMENTa SignalEnablerSearchSession
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerSearch() is true .
MethodgetSignalEnablerSearchSessionForMap
Description

Gets the OsidSession associated with the signal enabler earch service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerSearchSessiona SignalEnablerSearchSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerSearch() and supportsVisibleFederation() are true .
MethodgetSignalEnablerAdminSession
Description

Gets the OsidSession associated with the signal enabler administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerAdminSessiona SignalEnablerAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerAdmin() is true .
MethodgetSignalEnablerAdminSessionForMap
Description

Gets the OsidSession associated with the signal enabler administration service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerAdminSessiona SignalEnablerAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetSignalEnablerNotificationSession
Description

Gets the OsidSession associated with the signal enabler notification service.

Parametersosid.mapping.path.rules.SignalEnablerReceiversignalEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerNotificationSessiona SignalEnablerNotificationSession
ErrorsNULL_ARGUMENTsignalEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerNotification() is true .
MethodgetSignalEnablerNotificationSessionForMap
Description

Gets the OsidSession associated with the signal enabler notification service for the given map.

Parametersosid.mapping.path.rules.SignalEnablerReceiversignalEnablerReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerNotificationSessiona SignalEnablerNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENTsignalEnablerReceiver, mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerNotification() and supportsVisibleFederation() are true .
MethodgetSignalEnablerMapSession
Description

Gets the OsidSession to lookup signal enabler/map mappings for signal enablers.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerMapSessiona SignalEnablerMapSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerMap() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerMap() is true .
MethodgetSignalEnablerMapAssignmentSession
Description

Gets the OsidSession associated with assigning signal enabler to map.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerMapAssignmentSessiona SignalEnablerMapAssignmentSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerMapAssignment() is true .
MethodgetSignalEnablerSmartMapSession
Description

Gets the OsidSession to manage signal enabler smart map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerSmartMapSessiona SignalEnablerSmartMapSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerSmartMap() is true .
MethodgetSignalEnablerRuleLookupSession
Description

Gets the OsidSession associated with the signal enabler mapping lookup service for looking up the rules applied to a signal.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerRuleLookupSessiona SignalEnablerRuleLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerRuleLookup() is true .
MethodgetSignalEnablerRuleLookupSessionForMap
Description

Gets the OsidSession associated with the signal enabler mapping lookup service for the given map for looking up rules applied to a signal.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerRuleLookupSessiona SignalEnablerRuleLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetSignalEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the signal enabler assignment service to apply to signals.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerRuleApplicationSessiona SignalEnablerRuleApplicationSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerRuleApplication() is true .
MethodgetSignalEnablerRuleApplicationSessionForMap
Description

Gets the OsidSession associated with the signal enabler assignment service for the given map to apply to signals.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.SignalEnablerRuleApplicationSessiona SignalEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSignalEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetObstacleEnablerLookupSession
Description

Gets the OsidSession associated with the obstacle enabler lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerLookupSessionan ObstacleEnablerLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerLookup() is true .
MethodgetObstacleEnablerLookupSessionForMap
Description

Gets the OsidSession associated with the obstacle enabler lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerLookupSessionan ObstacleEnablerLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerLookup() and supportsVisibleFederation() are true .
MethodgetObstacleEnablerQuerySession
Description

Gets the OsidSession associated with the obstacle enabler query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerQuerySessionan ObstacleEnablerQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerQuery() is true .
MethodgetObstacleEnablerQuerySessionForMap
Description

Gets the OsidSession associated with the obstacle enabler query service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerQuerySessionan ObstacleEnablerQuerySession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerQuery() and supportsVisibleFederation() are true .
MethodgetObstacleEnablerSearchSession
Description

Gets the OsidSession associated with the obstacle enabler search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerSearchSessionan ObstacleEnablerSearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerSearch() is true .
MethodgetObstacleEnablerSearchSessionForMap
Description

Gets the OsidSession associated with the obstacle enabler earch service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerSearchSessionan ObstacleEnablerSearchSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerSearch() and supportsVisibleFederation() are true .
MethodgetObstacleEnablerAdminSession
Description

Gets the OsidSession associated with the obstacle enabler administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerAdminSessionan ObstacleEnablerAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerAdmin() is true .
MethodgetObstacleEnablerAdminSessionForMap
Description

Gets the OsidSession associated with the obstacle enabler administration service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerAdminSessionan ObstacleEnablerAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetObstacleEnablerNotificationSession
Description

Gets the OsidSession associated with the obstacle enabler notification service.

Parametersosid.mapping.path.rules.ObstacleEnablerReceiverobstacleEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerNotificationSessionan ObstacleEnablerNotificationSession
ErrorsNULL_ARGUMENTobstacleEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerNotification() is true .
MethodgetObstacleEnablerNotificationSessionForMap
Description

Gets the OsidSession associated with the obstacle enabler notification service for the given map.

Parametersosid.mapping.path.rules.ObstacleEnablerReceiverobstacleEnablerReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerNotificationSessionan ObstacleEnablerNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENTobstacleEnablerReceiver, mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerNotification() and supportsVisibleFederation() are true .
MethodgetObstacleEnablerMapSession
Description

Gets the OsidSession to lookup obstacle enabler/map mappings for obstacle enablers.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerMapSessionan ObstacleEnablerMapSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerMap() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerMap() is true .
MethodgetObstacleEnablerMapAssignmentSession
Description

Gets the OsidSession associated with assigning obstacle enabler to map.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerMapAssignmentSessionan ObstacleEnablerMapAssignmentSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerMapAssignment() is true .
MethodgetObstacleEnablerSmartMapSession
Description

Gets the OsidSession to manage obstacle enabler smart map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerSmartMapSessionan ObstacleEnablerSmartMapSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerSmartMap() is true .
MethodgetObstacleEnablerRuleLookupSession
Description

Gets the OsidSession associated with the obstacle enabler mapping lookup service for looking up the rules applied to an obstacle.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerRuleLookupSessionan ObstacleEnablerRuleLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerRuleLookup() is true .
MethodgetObstacleEnablerRuleLookupSessionForMap
Description

Gets the OsidSession associated with the obstacle enabler mapping lookup service for the given map for looking up rules applied to an obstacle.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerRuleLookupSessionan ObstacleEnablerRuleLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetObstacleEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the obstacle enabler assignment service to apply to obstacles.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerRuleApplicationSessionan ObstacleEnablerRuleApplicationSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerRuleApplication() is true .
MethodgetObstacleEnablerRuleApplicationSessionForMap
Description

Gets the OsidSession associated with the obstacle enabler assignment service for the given map to apply to obstacles.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.path.rules.ObstacleEnablerRuleApplicationSessionan ObstacleEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENTmapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsObstacleEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerRuleApplication() and supportsVisibleFederation() are true .