OSID Logo
OSID Specifications
mapping path rules package
Version 3.1.0
Interfaceosid.mapping.path.rules.MappingPathRulesManager
Implementsosid.OsidManager
osid.mapping.path.rules.MappingPathRulesProfile
Used Byosid.mapping.path.MappingPathManager
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:

  • 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
  • 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 signals
  • 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.

Returnosid.mapping.path.rules.SpeedZoneEnablerLookupSession a SpeedZoneEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerLookup() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SpeedZoneEnablerLookupSession a SpeedZoneEnablerLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSpeedZoneEnablerLookup() and supportsVisibleFederation() are true.
MethodgetSpeedZoneEnablerQuerySession
Description

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

Returnosid.mapping.path.rules.SpeedZoneEnablerQuerySession a SpeedZoneEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerQuery() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SpeedZoneEnablerQuerySession a SpeedZoneEnablerQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSpeedZoneEnablerQuery() and supportsVisibleFederation() are true.
MethodgetSpeedZoneEnablerSearchSession
Description

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

Returnosid.mapping.path.rules.SpeedZoneEnablerSearchSession a SpeedZoneEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerSearch() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SpeedZoneEnablerSearchSession a SpeedZoneEnablerSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSpeedZoneEnablerSearch() and supportsVisibleFederation() are true.
MethodgetSpeedZoneEnablerAdminSession
Description

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

Returnosid.mapping.path.rules.SpeedZoneEnablerAdminSession a SpeedZoneEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerAdmin() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SpeedZoneEnablerAdminSession a SpeedZoneEnablerAdminSession
ErrorsNOT_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
Complianceoptional This 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.SpeedZoneEnablerReceiverspeedZoneEnablerReceiver the notification callback
Returnosid.mapping.path.rules.SpeedZoneEnablerNotificationSession a SpeedZoneEnablerNotificationSession
ErrorsNULL_ARGUMENT speedZoneEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerNotification() is false
Complianceoptional This 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.SpeedZoneEnablerReceiverspeedZoneEnablerReceiver the notification callback
osid.id.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SpeedZoneEnablerNotificationSession a SpeedZoneEnablerNotificationSession
ErrorsNOT_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
Complianceoptional This 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.

Returnosid.mapping.path.rules.SpeedZoneEnablerMapSession a SpeedZoneEnablerMapSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerMap() is false
Complianceoptional This method must be implemented if supportsSpeedZoneEnablerMap() is true.
MethodgetSpeedZoneEnablerMapAssignmentSession
Description

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

Returnosid.mapping.path.rules.SpeedZoneEnablerMapAssignmentSession a SpeedZoneEnablerMapAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerMapAssignment() is false
Complianceoptional This method must be implemented if supportsSpeedZoneEnablerMapAssignment() is true.
MethodgetSpeedZoneEnablerSmartMapSession
Description

Gets the OsidSession to manage speed zone enabler smart map.

Parametersosid.id.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SpeedZoneEnablerSmartMapSession a SpeedZoneEnablerSmartMapSession
ErrorsNOT_FOUND no Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerSmartMap() is false
Complianceoptional This method must be implemented if supportsSpeedZoneEnablerSmartMap() is true.
MethodgetSpeedZoneEnablerRuleLookupSession
Description

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

Returnosid.mapping.path.rules.SpeedZoneEnablerRuleLookupSession a SpeedZoneEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerRuleLookup() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SpeedZoneEnablerRuleLookupSession a SpeedZoneEnablerRuleLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSpeedZoneEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetSpeedZoneEnablerRuleApplicationSession
Description

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

Returnosid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSession a SpeedZoneEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerRuleApplication() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSession a SpeedZoneEnablerRuleApplicationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSpeedZoneEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetSignalEnablerLookupSession
Description

Gets the OsidSession associated with the signal enabler lookup service.

Returnosid.mapping.path.rules.SignalEnablerLookupSession a SignalEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerLookup() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SignalEnablerLookupSession a SignalEnablerLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSignalEnablerLookup() and supportsVisibleFederation() are true.
MethodgetSignalEnablerQuerySession
Description

Gets the OsidSession associated with the signal enabler query service.

Returnosid.mapping.path.rules.SignalEnablerQuerySession a SignalEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerQuery() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SignalEnablerQuerySession a SignalEnablerQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSignalEnablerQuery() and supportsVisibleFederation() are true.
MethodgetSignalEnablerSearchSession
Description

Gets the OsidSession associated with the signal enabler search service.

Returnosid.mapping.path.rules.SignalEnablerSearchSession a SignalEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerSearch() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SignalEnablerSearchSession a SignalEnablerSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSignalEnablerSearch() and supportsVisibleFederation() are true.
MethodgetSignalEnablerAdminSession
Description

Gets the OsidSession associated with the signal enabler administration service.

Returnosid.mapping.path.rules.SignalEnablerAdminSession a SignalEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerAdmin() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SignalEnablerAdminSession a SignalEnablerAdminSession
ErrorsNOT_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
Complianceoptional This 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.SignalEnablerReceiversignalEnablerReceiver the notification callback
Returnosid.mapping.path.rules.SignalEnablerNotificationSession a SignalEnablerNotificationSession
ErrorsNULL_ARGUMENT signalEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerNotification() is false
Complianceoptional This 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.SignalEnablerReceiversignalEnablerReceiver the notification callback
osid.id.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SignalEnablerNotificationSession a SignalEnablerNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSignalEnablerNotification() and supportsVisibleFederation() are true.
MethodgetSignalEnablerMapSession
Description

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

Returnosid.mapping.path.rules.SignalEnablerMapSession a SignalEnablerMapSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerMap() is false
Complianceoptional This method must be implemented if supportsSignalEnablerMap() is true.
MethodgetSignalEnablerMapAssignmentSession
Description

Gets the OsidSession associated with assigning signal enabler to map.

Returnosid.mapping.path.rules.SignalEnablerMapAssignmentSession a SignalEnablerMapAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerMapAssignment() is false
Complianceoptional This method must be implemented if supportsSignalEnablerMapAssignment() is true.
MethodgetSignalEnablerSmartMapSession
Description

Gets the OsidSession to manage signal enabler smart map.

Parametersosid.id.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SignalEnablerSmartMapSession a SignalEnablerSmartMapSession
ErrorsNOT_FOUND no Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerSmartMap() is false
Complianceoptional This 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 the signal.

Returnosid.mapping.path.rules.SignalEnablerRuleLookupSession a SignalEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerRuleLookup() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SignalEnablerRuleLookupSession a SignalEnablerRuleLookupSession
ErrorsNOT_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
Complianceoptional This 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.

Returnosid.mapping.path.rules.SignalEnablerRuleApplicationSession a SignalEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalEnablerRuleApplication() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.SignalEnablerRuleApplicationSession a SignalEnablerRuleApplicationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSignalEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetObstacleEnablerLookupSession
Description

Gets the OsidSession associated with the obstacle enabler lookup service.

Returnosid.mapping.path.rules.ObstacleEnablerLookupSession an ObstacleEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerLookup() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.ObstacleEnablerLookupSession an ObstacleEnablerLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsObstacleEnablerLookup() and supportsVisibleFederation() are true.
MethodgetObstacleEnablerQuerySession
Description

Gets the OsidSession associated with the obstacle enabler query service.

Returnosid.mapping.path.rules.ObstacleEnablerQuerySession an ObstacleEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerQuery() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.ObstacleEnablerQuerySession an ObstacleEnablerQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsObstacleEnablerQuery() and supportsVisibleFederation() are true.
MethodgetObstacleEnablerSearchSession
Description

Gets the OsidSession associated with the obstacle enabler search service.

Returnosid.mapping.path.rules.ObstacleEnablerSearchSession an ObstacleEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerSearch() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.ObstacleEnablerSearchSession an ObstacleEnablerSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsObstacleEnablerSearch() and supportsVisibleFederation() are true.
MethodgetObstacleEnablerAdminSession
Description

Gets the OsidSession associated with the obstacle enabler administration service.

Returnosid.mapping.path.rules.ObstacleEnablerAdminSession an ObstacleEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerAdmin() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.ObstacleEnablerAdminSession an ObstacleEnablerAdminSession
ErrorsNOT_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
Complianceoptional This 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.ObstacleEnablerReceiverobstacleEnablerReceiver the notification callback
Returnosid.mapping.path.rules.ObstacleEnablerNotificationSession an ObstacleEnablerNotificationSession
ErrorsNULL_ARGUMENT obstacleEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerNotification() is false
Complianceoptional This 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.ObstacleEnablerReceiverobstacleEnablerReceiver the notification callback
osid.id.IdmapId the Id of the Map
Returnosid.mapping.path.rules.ObstacleEnablerNotificationSession an ObstacleEnablerNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsObstacleEnablerNotification() and supportsVisibleFederation() are true.
MethodgetObstacleEnablerMapSession
Description

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

Returnosid.mapping.path.rules.ObstacleEnablerMapSession an ObstacleEnablerMapSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerMap() is false
Complianceoptional This method must be implemented if supportsObstacleEnablerMap() is true.
MethodgetObstacleEnablerMapAssignmentSession
Description

Gets the OsidSession associated with assigning obstacle enabler to map.

Returnosid.mapping.path.rules.ObstacleEnablerMapAssignmentSession an ObstacleEnablerMapAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerMapAssignment() is false
Complianceoptional This method must be implemented if supportsObstacleEnablerMapAssignment() is true.
MethodgetObstacleEnablerSmartMapSession
Description

Gets the OsidSession to manage obstacle enabler smart map.

Parametersosid.id.IdmapId the Id of the Map
Returnosid.mapping.path.rules.ObstacleEnablerSmartMapSession an ObstacleEnablerSmartMapSession
ErrorsNOT_FOUND no Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerSmartMap() is false
Complianceoptional This 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 the obstacle.

Returnosid.mapping.path.rules.ObstacleEnablerRuleLookupSession an ObstacleEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerRuleLookup() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.ObstacleEnablerRuleLookupSession an ObstacleEnablerRuleLookupSession
ErrorsNOT_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
Complianceoptional This 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.

Returnosid.mapping.path.rules.ObstacleEnablerRuleApplicationSession an ObstacleEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleEnablerRuleApplication() is false
Complianceoptional This 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.IdmapId the Id of the Map
Returnosid.mapping.path.rules.ObstacleEnablerRuleApplicationSession an ObstacleEnablerRuleApplicationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsObstacleEnablerRuleApplication() and supportsVisibleFederation() are true.