OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.MappingPathRulesManager
Implementsosid.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:

  • 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.SpeedZoneEnablerLookupSessiona SpeedZoneEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerLookup() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerLookupSessiona SpeedZoneEnablerLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerLookup() 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.

Returnosid.mapping.path.rules.SpeedZoneEnablerQuerySessiona SpeedZoneEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerQuery() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerQuerySessiona SpeedZoneEnablerQuerySession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerQuery() 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.

Returnosid.mapping.path.rules.SpeedZoneEnablerSearchSessiona SpeedZoneEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerSearch() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerSearchSessiona SpeedZoneEnablerSearchSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerSearch() 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.

Returnosid.mapping.path.rules.SpeedZoneEnablerAdminSessiona SpeedZoneEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerAdmin() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerAdminSessiona SpeedZoneEnablerAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerAdmin() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerNotificationSessiona SpeedZoneEnablerNotificationSession
ErrorsNULL_ARGUMENT speedZoneEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerNotification() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerNotificationSessiona SpeedZoneEnablerNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT speedZoneEnablerReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerNotification() 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.

Returnosid.mapping.path.rules.SpeedZoneEnablerMapSessiona SpeedZoneEnablerMapSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerMap() is false
ComplianceoptionalThis 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.SpeedZoneEnablerMapAssignmentSessiona SpeedZoneEnablerMapAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerMapAssignment() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerSmartMapSessiona SpeedZoneEnablerSmartMapSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerSmartMap() 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.

Returnosid.mapping.path.rules.SpeedZoneEnablerRuleLookupSessiona SpeedZoneEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerRuleLookup() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerRuleLookupSessiona SpeedZoneEnablerRuleLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerRuleLookup() 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.

Returnosid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSessiona SpeedZoneEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerRuleApplication() 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
Returnosid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSessiona SpeedZoneEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneEnablerRuleApplication() 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.

Returnosid.mapping.path.rules.SignalEnablerLookupSessiona SignalEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerLookup() 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
Returnosid.mapping.path.rules.SignalEnablerLookupSessiona SignalEnablerLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerLookup() 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.

Returnosid.mapping.path.rules.SignalEnablerQuerySessiona SignalEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerQuery() 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
Returnosid.mapping.path.rules.SignalEnablerQuerySessiona SignalEnablerQuerySession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerQuery() 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.

Returnosid.mapping.path.rules.SignalEnablerSearchSessiona SignalEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerSearch() 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
Returnosid.mapping.path.rules.SignalEnablerSearchSessiona SignalEnablerSearchSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerSearch() 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.

Returnosid.mapping.path.rules.SignalEnablerAdminSessiona SignalEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerAdmin() 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
Returnosid.mapping.path.rules.SignalEnablerAdminSessiona SignalEnablerAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerAdmin() 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
Returnosid.mapping.path.rules.SignalEnablerNotificationSessiona SignalEnablerNotificationSession
ErrorsNULL_ARGUMENT signalEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerNotification() 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
Returnosid.mapping.path.rules.SignalEnablerNotificationSessiona SignalEnablerNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT signalEnablerReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerNotification() 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.

Returnosid.mapping.path.rules.SignalEnablerMapSessiona SignalEnablerMapSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerMap() is false
ComplianceoptionalThis method must be implemented if supportsSignalEnablerMap() is true.
MethodgetSignalEnablerMapAssignmentSession
Description

Gets the OsidSession associated with assigning signal enabler to map.

Returnosid.mapping.path.rules.SignalEnablerMapAssignmentSessiona SignalEnablerMapAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerMapAssignment() 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
Returnosid.mapping.path.rules.SignalEnablerSmartMapSessiona SignalEnablerSmartMapSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerSmartMap() 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 the signal.

Returnosid.mapping.path.rules.SignalEnablerRuleLookupSessiona SignalEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerRuleLookup() 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
Returnosid.mapping.path.rules.SignalEnablerRuleLookupSessiona SignalEnablerRuleLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerRuleLookup() 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.

Returnosid.mapping.path.rules.SignalEnablerRuleApplicationSessiona SignalEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerRuleApplication() 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
Returnosid.mapping.path.rules.SignalEnablerRuleApplicationSessiona SignalEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalEnablerRuleApplication() 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.

Returnosid.mapping.path.rules.ObstacleEnablerLookupSessionan ObstacleEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerLookup() 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
Returnosid.mapping.path.rules.ObstacleEnablerLookupSessionan ObstacleEnablerLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerLookup() 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.

Returnosid.mapping.path.rules.ObstacleEnablerQuerySessionan ObstacleEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerQuery() 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
Returnosid.mapping.path.rules.ObstacleEnablerQuerySessionan ObstacleEnablerQuerySession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerQuery() 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.

Returnosid.mapping.path.rules.ObstacleEnablerSearchSessionan ObstacleEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerSearch() 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
Returnosid.mapping.path.rules.ObstacleEnablerSearchSessionan ObstacleEnablerSearchSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerSearch() 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.

Returnosid.mapping.path.rules.ObstacleEnablerAdminSessionan ObstacleEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerAdmin() 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
Returnosid.mapping.path.rules.ObstacleEnablerAdminSessionan ObstacleEnablerAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerAdmin() 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
Returnosid.mapping.path.rules.ObstacleEnablerNotificationSessionan ObstacleEnablerNotificationSession
ErrorsNULL_ARGUMENT obstacleEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerNotification() 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
Returnosid.mapping.path.rules.ObstacleEnablerNotificationSessionan ObstacleEnablerNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT obstacleEnablerReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerNotification() 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.

Returnosid.mapping.path.rules.ObstacleEnablerMapSessionan ObstacleEnablerMapSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerMap() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerMap() is true.
MethodgetObstacleEnablerMapAssignmentSession
Description

Gets the OsidSession associated with assigning obstacle enabler to map.

Returnosid.mapping.path.rules.ObstacleEnablerMapAssignmentSessionan ObstacleEnablerMapAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerMapAssignment() 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
Returnosid.mapping.path.rules.ObstacleEnablerSmartMapSessionan ObstacleEnablerSmartMapSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerSmartMap() 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 the obstacle.

Returnosid.mapping.path.rules.ObstacleEnablerRuleLookupSessionan ObstacleEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerRuleLookup() 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
Returnosid.mapping.path.rules.ObstacleEnablerRuleLookupSessionan ObstacleEnablerRuleLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerRuleLookup() 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.

Returnosid.mapping.path.rules.ObstacleEnablerRuleApplicationSessionan ObstacleEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerRuleApplication() 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
Returnosid.mapping.path.rules.ObstacleEnablerRuleApplicationSessionan ObstacleEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleEnablerRuleApplication() and supportsVisibleFederation() are true.