Interface MappingPathRulesManager

All Superinterfaces:

AutoCloseable, Closeable, MappingPathRulesProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface MappingPathRulesManager
extends OsidManager, MappingPathRulesProfile

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

Method Summary

Modifier and Type	Method	Description
ObstacleEnablerAdminSession	getObstacleEnablerAdminSession()	Gets the OsidSession associated with the obstacle enabler administration service.
ObstacleEnablerAdminSession	getObstacleEnablerAdminSessionForMap(Id mapId)	Gets the OsidSession associated with the obstacle enabler administration service for the given map.
ObstacleEnablerLookupSession	getObstacleEnablerLookupSession()	Gets the OsidSession associated with the obstacle enabler lookup service.
ObstacleEnablerLookupSession	getObstacleEnablerLookupSessionForMap(Id mapId)	Gets the OsidSession associated with the obstacle enabler lookup service for the given map.
ObstacleEnablerMapAssignmentSession	getObstacleEnablerMapAssignmentSession()	Gets the OsidSession associated with assigning obstacle enabler to map.
ObstacleEnablerMapSession	getObstacleEnablerMapSession()	Gets the OsidSession to lookup obstacle enabler/map mappings for obstacle enablers.
ObstacleEnablerNotificationSession	getObstacleEnablerNotificationSession(ObstacleEnablerReceiver obstacleEnablerReceiver)	Gets the OsidSession associated with the obstacle enabler notification service.
ObstacleEnablerNotificationSession	getObstacleEnablerNotificationSessionForMap(ObstacleEnablerReceiver obstacleEnablerReceiver, Id mapId)	Gets the OsidSession associated with the obstacle enabler notification service for the given map.
ObstacleEnablerQuerySession	getObstacleEnablerQuerySession()	Gets the OsidSession associated with the obstacle enabler query service.
ObstacleEnablerQuerySession	getObstacleEnablerQuerySessionForMap(Id mapId)	Gets the OsidSession associated with the obstacle enabler query service for the given map.
ObstacleEnablerRuleApplicationSession	getObstacleEnablerRuleApplicationSession()	Gets the OsidSession associated with the obstacle enabler assignment service to apply to obstacles.
ObstacleEnablerRuleApplicationSession	getObstacleEnablerRuleApplicationSessionForMap(Id mapId)	Gets the OsidSession associated with the obstacle enabler assignment service for the given map to apply to obstacles.
ObstacleEnablerRuleLookupSession	getObstacleEnablerRuleLookupSession()	Gets the OsidSession associated with the obstacle enabler mapping lookup service for looking up the rules applied to the obstacle.
ObstacleEnablerRuleLookupSession	getObstacleEnablerRuleLookupSessionForMap(Id mapId)	Gets the OsidSession associated with the obstacle enabler mapping lookup service for the given map for looking up rules applied to an obstacle.
ObstacleEnablerSearchSession	getObstacleEnablerSearchSession()	Gets the OsidSession associated with the obstacle enabler search service.
ObstacleEnablerSearchSession	getObstacleEnablerSearchSessionForMap(Id mapId)	Gets the OsidSession associated with the obstacle enabler earch service for the given map.
ObstacleEnablerSmartMapSession	getObstacleEnablerSmartMapSession(Id mapId)	Gets the OsidSession to manage obstacle enabler smart map.
SignalEnablerAdminSession	getSignalEnablerAdminSession()	Gets the OsidSession associated with the signal enabler administration service.
SignalEnablerAdminSession	getSignalEnablerAdminSessionForMap(Id mapId)	Gets the OsidSession associated with the signal enabler administration service for the given map.
SignalEnablerLookupSession	getSignalEnablerLookupSession()	Gets the OsidSession associated with the signal enabler lookup service.
SignalEnablerLookupSession	getSignalEnablerLookupSessionForMap(Id mapId)	Gets the OsidSession associated with the signal enabler lookup service for the given map.
SignalEnablerMapAssignmentSession	getSignalEnablerMapAssignmentSession()	Gets the OsidSession associated with assigning signal enabler to map.
SignalEnablerMapSession	getSignalEnablerMapSession()	Gets the OsidSession to lookup signal enabler/map mappings for signal enablers.
SignalEnablerNotificationSession	getSignalEnablerNotificationSession(SignalEnablerReceiver signalEnablerReceiver)	Gets the OsidSession associated with the signal enabler notification service.
SignalEnablerNotificationSession	getSignalEnablerNotificationSessionForMap(SignalEnablerReceiver signalEnablerReceiver, Id mapId)	Gets the OsidSession associated with the signal enabler notification service for the given map.
SignalEnablerQuerySession	getSignalEnablerQuerySession()	Gets the OsidSession associated with the signal enabler query service.
SignalEnablerQuerySession	getSignalEnablerQuerySessionForMap(Id mapId)	Gets the OsidSession associated with the signal enabler query service for the given map.
SignalEnablerRuleApplicationSession	getSignalEnablerRuleApplicationSession()	Gets the OsidSession associated with the signal enabler assignment service to apply to signals.
SignalEnablerRuleApplicationSession	getSignalEnablerRuleApplicationSessionForMap(Id mapId)	Gets the OsidSession associated with the signal enabler assignment service for the given map to apply to signals.
SignalEnablerRuleLookupSession	getSignalEnablerRuleLookupSession()	Gets the OsidSession associated with the signal enabler mapping lookup service for looking up the rules applied to the signal.
SignalEnablerRuleLookupSession	getSignalEnablerRuleLookupSessionForMap(Id mapId)	Gets the OsidSession associated with the signal enabler mapping lookup service for the given map for looking up rules applied to a signal.
SignalEnablerSearchSession	getSignalEnablerSearchSession()	Gets the OsidSession associated with the signal enabler search service.
SignalEnablerSearchSession	getSignalEnablerSearchSessionForMap(Id mapId)	Gets the OsidSession associated with the signal enabler earch service for the given map.
SignalEnablerSmartMapSession	getSignalEnablerSmartMapSession(Id mapId)	Gets the OsidSession to manage signal enabler smart map.
SpeedZoneEnablerAdminSession	getSpeedZoneEnablerAdminSession()	Gets the OsidSession associated with the speed zone enabler administration service.
SpeedZoneEnablerAdminSession	getSpeedZoneEnablerAdminSessionForMap(Id mapId)	Gets the OsidSession associated with the speed zone enabler administration service for the given map.
SpeedZoneEnablerLookupSession	getSpeedZoneEnablerLookupSession()	Gets the OsidSession associated with the speed zone enabler lookup service.
SpeedZoneEnablerLookupSession	getSpeedZoneEnablerLookupSessionForMap(Id mapId)	Gets the OsidSession associated with the speed zone enabler lookup service for the given map.
SpeedZoneEnablerMapAssignmentSession	getSpeedZoneEnablerMapAssignmentSession()	Gets the OsidSession associated with assigning speed zone enablers to map.
SpeedZoneEnablerMapSession	getSpeedZoneEnablerMapSession()	Gets the OsidSession to lookup speed zone enabler/map mappings for speed zone enablers.
SpeedZoneEnablerNotificationSession	getSpeedZoneEnablerNotificationSession(SpeedZoneEnablerReceiver speedZoneEnablerReceiver)	Gets the OsidSession associated with the speed zone enabler notification service.
SpeedZoneEnablerNotificationSession	getSpeedZoneEnablerNotificationSessionForMap(SpeedZoneEnablerReceiver speedZoneEnablerReceiver, Id mapId)	Gets the OsidSession associated with the speed zone enabler notification service for the given map.
SpeedZoneEnablerQuerySession	getSpeedZoneEnablerQuerySession()	Gets the OsidSession associated with the speed zone enabler query service.
SpeedZoneEnablerQuerySession	getSpeedZoneEnablerQuerySessionForMap(Id mapId)	Gets the OsidSession associated with the speed zone enabler query service for the given map.
SpeedZoneEnablerRuleApplicationSession	getSpeedZoneEnablerRuleApplicationSession()	Gets the OsidSession associated with the speed zone enabler assignment service.
SpeedZoneEnablerRuleApplicationSession	getSpeedZoneEnablerRuleApplicationSessionForMap(Id mapId)	Gets the OsidSession associated with the speed zone enabler assignment service for the given map.
SpeedZoneEnablerRuleLookupSession	getSpeedZoneEnablerRuleLookupSession()	Gets the OsidSession associated with the speed zone enabler mapping lookup service.
SpeedZoneEnablerRuleLookupSession	getSpeedZoneEnablerRuleLookupSessionForMap(Id mapId)	Gets the OsidSession associated with the speed zone enabler mapping lookup service for the given map.
SpeedZoneEnablerSearchSession	getSpeedZoneEnablerSearchSession()	Gets the OsidSession associated with the speed zone enabler search service.
SpeedZoneEnablerSearchSession	getSpeedZoneEnablerSearchSessionForMap(Id mapId)	Gets the OsidSession associated with the speed zone enablers earch service for the given map.
SpeedZoneEnablerSmartMapSession	getSpeedZoneEnablerSmartMapSession(Id mapId)	Gets the OsidSession to manage speed zone enabler smart map.

Methods inherited from interface Closeable

close

Methods inherited from interface MappingPathRulesProfile

getObstacleEnablerRecordTypes, getObstacleEnablerSearchRecordTypes, getSignalEnablerRecordTypes, getSignalEnablerSearchRecordTypes, getSpeedZoneEnablerRecordTypes, getSpeedZoneEnablerSearchRecordTypes, supportsObstacleEnablerAdmin, supportsObstacleEnablerLookup, supportsObstacleEnablerMap, supportsObstacleEnablerMapAssignment, supportsObstacleEnablerNotification, supportsObstacleEnablerQuery, supportsObstacleEnablerRecordType, supportsObstacleEnablerRuleApplication, supportsObstacleEnablerRuleLookup, supportsObstacleEnablerSearch, supportsObstacleEnablerSearchRecordType, supportsObstacleEnablerSmartMap, supportsSignalEnablerAdmin, supportsSignalEnablerLookup, supportsSignalEnablerMap, supportsSignalEnablerMapAssignment, supportsSignalEnablerNotification, supportsSignalEnablerQuery, supportsSignalEnablerRecordType, supportsSignalEnablerRuleApplication, supportsSignalEnablerRuleLookup, supportsSignalEnablerSearch, supportsSignalEnablerSearchRecordType, supportsSignalEnablerSmartMap, supportsSpeedZoneEnablerAdmin, supportsSpeedZoneEnablerLookup, supportsSpeedZoneEnablerMap, supportsSpeedZoneEnablerMapAssignment, supportsSpeedZoneEnablerNotification, supportsSpeedZoneEnablerQuery, supportsSpeedZoneEnablerRecordType, supportsSpeedZoneEnablerRuleApplication, supportsSpeedZoneEnablerRuleLookup, supportsSpeedZoneEnablerSearch, supportsSpeedZoneEnablerSearchRecordType, supportsSpeedZoneEnablerSmartMap, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getObstacleEnablerRecordTypes()	Gets the supported ObstacleEnabler record types.
TypeList	getObstacleEnablerSearchRecordTypes()	Gets the supported ObstacleEnabler search record types.
TypeList	getSignalEnablerRecordTypes()	Gets the supported SignalEnabler record types.
TypeList	getSignalEnablerSearchRecordTypes()	Gets the supported SignalEnabler search record types.
TypeList	getSpeedZoneEnablerRecordTypes()	Gets the supported SpeedZoneEnabler record types.
TypeList	getSpeedZoneEnablerSearchRecordTypes()	Gets the supported SpeedZoneEnabler search record types.
boolean	supportsObstacleEnablerAdmin()	Tests if an obstacle enabler administrative service is supported.
boolean	supportsObstacleEnablerLookup()	Tests if looking up obstacle enabler is supported.
boolean	supportsObstacleEnablerMap()	Tests if an obstacle enabler map lookup service is supported.
boolean	supportsObstacleEnablerMapAssignment()	Tests if an obstacle enabler map service is supported.
boolean	supportsObstacleEnablerNotification()	Tests if an obstacle enabler notification service is supported.
boolean	supportsObstacleEnablerQuery()	Tests if querying obstacle enabler is supported.
boolean	supportsObstacleEnablerRecordType(Type obstacleEnablerRecordType)	Tests if the given ObstacleEnabler record type is supported.
boolean	supportsObstacleEnablerRuleApplication()	Tests if an obstacle enabler rule application service is supported.
boolean	supportsObstacleEnablerRuleLookup()	Tests if an obstacle enabler rule lookup service is supported.
boolean	supportsObstacleEnablerSearch()	Tests if searching obstacle enabler is supported.
boolean	supportsObstacleEnablerSearchRecordType(Type obstacleEnablerSearchRecordType)	Tests if the given ObstacleEnabler search record type is supported.
boolean	supportsObstacleEnablerSmartMap()	Tests if an obstacle enabler map lookup service is supported.
boolean	supportsSignalEnablerAdmin()	Tests if a signal enabler administrative service is supported.
boolean	supportsSignalEnablerLookup()	Tests if looking up signal enabler is supported.
boolean	supportsSignalEnablerMap()	Tests if a signal enabler map lookup service is supported.
boolean	supportsSignalEnablerMapAssignment()	Tests if a signal enabler map service is supported.
boolean	supportsSignalEnablerNotification()	Tests if a signal enabler notification service is supported.
boolean	supportsSignalEnablerQuery()	Tests if querying signal enabler is supported.
boolean	supportsSignalEnablerRecordType(Type signalEnablerRecordType)	Tests if the given SignalEnabler record type is supported.
boolean	supportsSignalEnablerRuleApplication()	Tests if a signal enabler rule application service is supported.
boolean	supportsSignalEnablerRuleLookup()	Tests if a signal enabler rule lookup service is supported.
boolean	supportsSignalEnablerSearch()	Tests if searching signal enabler is supported.
boolean	supportsSignalEnablerSearchRecordType(Type signalEnablerSearchRecordType)	Tests if the given SignalEnabler search record type is supported.
boolean	supportsSignalEnablerSmartMap()	Tests if a signal enabler map lookup service is supported.
boolean	supportsSpeedZoneEnablerAdmin()	Tests if a speed zone enabler administrative service is supported.
boolean	supportsSpeedZoneEnablerLookup()	Tests if looking up speed zone enablers is supported.
boolean	supportsSpeedZoneEnablerMap()	Tests if a speed zone enabler map lookup service is supported.
boolean	supportsSpeedZoneEnablerMapAssignment()	Tests if a speed zone enabler map service is supported.
boolean	supportsSpeedZoneEnablerNotification()	Tests if a speed zone enabler notification service is supported.
boolean	supportsSpeedZoneEnablerQuery()	Tests if querying speed zone enablers is supported.
boolean	supportsSpeedZoneEnablerRecordType(Type speedZoneEnablerRecordType)	Tests if the given SpeedZoneEnabler record type is supported.
boolean	supportsSpeedZoneEnablerRuleApplication()	Tests if a speed zone enabler rule application service is supported.
boolean	supportsSpeedZoneEnablerRuleLookup()	Tests if a speed zone enabler rule lookup service is supported.
boolean	supportsSpeedZoneEnablerSearch()	Tests if searching speed zone enablers is supported.
boolean	supportsSpeedZoneEnablerSearchRecordType(Type speedZoneEnablerSearchRecordType)	Tests if the given SpeedZoneEnabler search record type is supported.
boolean	supportsSpeedZoneEnablerSmartMap()	Tests if a speed zone enabler map lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getSpeedZoneEnablerLookupSession

SpeedZoneEnablerLookupSession getSpeedZoneEnablerLookupSession()
                                                        throws OperationFailedException

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

Returns:

a SpeedZoneEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerLookup()} is {@code true} .

getSpeedZoneEnablerLookupSessionForMap

SpeedZoneEnablerLookupSession getSpeedZoneEnablerLookupSessionForMap(Id mapId)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneEnablerLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getSpeedZoneEnablerQuerySession

SpeedZoneEnablerQuerySession getSpeedZoneEnablerQuerySession()
                                                      throws OperationFailedException

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

Returns:

a SpeedZoneEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerQuery()} is {@code true} .

getSpeedZoneEnablerQuerySessionForMap

SpeedZoneEnablerQuerySession getSpeedZoneEnablerQuerySessionForMap(Id mapId)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneEnablerQuerySession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getSpeedZoneEnablerSearchSession

SpeedZoneEnablerSearchSession getSpeedZoneEnablerSearchSession()
                                                        throws OperationFailedException

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

Returns:

a SpeedZoneEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerSearch()} is {@code true} .

getSpeedZoneEnablerSearchSessionForMap

SpeedZoneEnablerSearchSession getSpeedZoneEnablerSearchSessionForMap(Id mapId)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneEnablerSearchSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getSpeedZoneEnablerAdminSession

SpeedZoneEnablerAdminSession getSpeedZoneEnablerAdminSession()
                                                      throws OperationFailedException

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

Returns:

a SpeedZoneEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerAdmin()} is {@code true} .

getSpeedZoneEnablerAdminSessionForMap

SpeedZoneEnablerAdminSession getSpeedZoneEnablerAdminSessionForMap(Id mapId)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneEnablerAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getSpeedZoneEnablerNotificationSession

SpeedZoneEnablerNotificationSession getSpeedZoneEnablerNotificationSession(SpeedZoneEnablerReceiver speedZoneEnablerReceiver)
                                                                    throws OperationFailedException

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

Parameters:

speedZoneEnablerReceiver - the notification callback

Returns:

a SpeedZoneEnablerNotificationSession

Throws:

NullArgumentException - speedZoneEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerNotification()} is {@code true} .

getSpeedZoneEnablerNotificationSessionForMap

SpeedZoneEnablerNotificationSession getSpeedZoneEnablerNotificationSessionForMap(SpeedZoneEnablerReceiver speedZoneEnablerReceiver,
 Id mapId)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

speedZoneEnablerReceiver - the notification callback

mapId - the Id of the Map

Returns:

a SpeedZoneEnablerNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - speedZoneEnablerReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getSpeedZoneEnablerMapSession

SpeedZoneEnablerMapSession getSpeedZoneEnablerMapSession()
                                                  throws OperationFailedException

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

Returns:

a SpeedZoneEnablerMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerMap() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerMap()} is {@code true} .

getSpeedZoneEnablerMapAssignmentSession

SpeedZoneEnablerMapAssignmentSession getSpeedZoneEnablerMapAssignmentSession()
                                                                      throws OperationFailedException

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

Returns:

a SpeedZoneEnablerMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerMapAssignment()} is {@code true} .

getSpeedZoneEnablerSmartMapSession

SpeedZoneEnablerSmartMapSession getSpeedZoneEnablerSmartMapSession(Id mapId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage speed zone enabler smart map.

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneEnablerSmartMapSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerSmartMap()} is {@code true} .

getSpeedZoneEnablerRuleLookupSession

SpeedZoneEnablerRuleLookupSession getSpeedZoneEnablerRuleLookupSession()
                                                                throws OperationFailedException

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

Returns:

a SpeedZoneEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerRuleLookup()} is {@code true} .

getSpeedZoneEnablerRuleLookupSessionForMap

SpeedZoneEnablerRuleLookupSession getSpeedZoneEnablerRuleLookupSessionForMap(Id mapId)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneEnablerRuleLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getSpeedZoneEnablerRuleApplicationSession

SpeedZoneEnablerRuleApplicationSession getSpeedZoneEnablerRuleApplicationSession()
                                                                          throws OperationFailedException

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

Returns:

a SpeedZoneEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerRuleApplication()} is {@code true} .

getSpeedZoneEnablerRuleApplicationSessionForMap

SpeedZoneEnablerRuleApplicationSession getSpeedZoneEnablerRuleApplicationSessionForMap(Id mapId)
                                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneEnablerRuleApplicationSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getSignalEnablerLookupSession

SignalEnablerLookupSession getSignalEnablerLookupSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the signal enabler lookup service.

Returns:

a SignalEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerLookup()} is {@code true} .

getSignalEnablerLookupSessionForMap

SignalEnablerLookupSession getSignalEnablerLookupSessionForMap(Id mapId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalEnablerLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getSignalEnablerQuerySession

SignalEnablerQuerySession getSignalEnablerQuerySession()
                                                throws OperationFailedException

Gets the OsidSession associated with the signal enabler query service.

Returns:

a SignalEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerQuery()} is {@code true} .

getSignalEnablerQuerySessionForMap

SignalEnablerQuerySession getSignalEnablerQuerySessionForMap(Id mapId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalEnablerQuerySession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getSignalEnablerSearchSession

SignalEnablerSearchSession getSignalEnablerSearchSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the signal enabler search service.

Returns:

a SignalEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerSearch()} is {@code true} .

getSignalEnablerSearchSessionForMap

SignalEnablerSearchSession getSignalEnablerSearchSessionForMap(Id mapId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalEnablerSearchSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getSignalEnablerAdminSession

SignalEnablerAdminSession getSignalEnablerAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the signal enabler administration service.

Returns:

a SignalEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerAdmin()} is {@code true} .

getSignalEnablerAdminSessionForMap

SignalEnablerAdminSession getSignalEnablerAdminSessionForMap(Id mapId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalEnablerAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getSignalEnablerNotificationSession

SignalEnablerNotificationSession getSignalEnablerNotificationSession(SignalEnablerReceiver signalEnablerReceiver)
                                                              throws OperationFailedException

Gets the OsidSession associated with the signal enabler notification service.

Parameters:

signalEnablerReceiver - the notification callback

Returns:

a SignalEnablerNotificationSession

Throws:

NullArgumentException - signalEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerNotification()} is {@code true} .

getSignalEnablerNotificationSessionForMap

SignalEnablerNotificationSession getSignalEnablerNotificationSessionForMap(SignalEnablerReceiver signalEnablerReceiver,
 Id mapId)
                                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

signalEnablerReceiver - the notification callback

mapId - the Id of the Map

Returns:

a SignalEnablerNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - signalEnablerReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getSignalEnablerMapSession

SignalEnablerMapSession getSignalEnablerMapSession()
                                            throws OperationFailedException

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

Returns:

a SignalEnablerMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerMap() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerMap()} is {@code true} .

getSignalEnablerMapAssignmentSession

SignalEnablerMapAssignmentSession getSignalEnablerMapAssignmentSession()
                                                                throws OperationFailedException

Gets the OsidSession associated with assigning signal enabler to map.

Returns:

a SignalEnablerMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerMapAssignment()} is {@code true} .

getSignalEnablerSmartMapSession

SignalEnablerSmartMapSession getSignalEnablerSmartMapSession(Id mapId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage signal enabler smart map.

Parameters:

mapId - the Id of the Map

Returns:

a SignalEnablerSmartMapSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerSmartMap()} is {@code true} .

getSignalEnablerRuleLookupSession

SignalEnablerRuleLookupSession getSignalEnablerRuleLookupSession()
                                                          throws OperationFailedException

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

Returns:

a SignalEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerRuleLookup()} is {@code true} .

getSignalEnablerRuleLookupSessionForMap

SignalEnablerRuleLookupSession getSignalEnablerRuleLookupSessionForMap(Id mapId)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalEnablerRuleLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getSignalEnablerRuleApplicationSession

SignalEnablerRuleApplicationSession getSignalEnablerRuleApplicationSession()
                                                                    throws OperationFailedException

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

Returns:

a SignalEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerRuleApplication()} is {@code true} .

getSignalEnablerRuleApplicationSessionForMap

SignalEnablerRuleApplicationSession getSignalEnablerRuleApplicationSessionForMap(Id mapId)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalEnablerRuleApplicationSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getObstacleEnablerLookupSession

ObstacleEnablerLookupSession getObstacleEnablerLookupSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the obstacle enabler lookup service.

Returns:

an ObstacleEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerLookup()} is {@code true} .

getObstacleEnablerLookupSessionForMap

ObstacleEnablerLookupSession getObstacleEnablerLookupSessionForMap(Id mapId)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleEnablerLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getObstacleEnablerQuerySession

ObstacleEnablerQuerySession getObstacleEnablerQuerySession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the obstacle enabler query service.

Returns:

an ObstacleEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerQuery()} is {@code true} .

getObstacleEnablerQuerySessionForMap

ObstacleEnablerQuerySession getObstacleEnablerQuerySessionForMap(Id mapId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleEnablerQuerySession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getObstacleEnablerSearchSession

ObstacleEnablerSearchSession getObstacleEnablerSearchSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the obstacle enabler search service.

Returns:

an ObstacleEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerSearch()} is {@code true} .

getObstacleEnablerSearchSessionForMap

ObstacleEnablerSearchSession getObstacleEnablerSearchSessionForMap(Id mapId)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleEnablerSearchSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getObstacleEnablerAdminSession

ObstacleEnablerAdminSession getObstacleEnablerAdminSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the obstacle enabler administration service.

Returns:

an ObstacleEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerAdmin()} is {@code true} .

getObstacleEnablerAdminSessionForMap

ObstacleEnablerAdminSession getObstacleEnablerAdminSessionForMap(Id mapId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleEnablerAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getObstacleEnablerNotificationSession

ObstacleEnablerNotificationSession getObstacleEnablerNotificationSession(ObstacleEnablerReceiver obstacleEnablerReceiver)
                                                                  throws OperationFailedException

Gets the OsidSession associated with the obstacle enabler notification service.

Parameters:

obstacleEnablerReceiver - the notification callback

Returns:

an ObstacleEnablerNotificationSession

Throws:

NullArgumentException - obstacleEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerNotification()} is {@code true} .

getObstacleEnablerNotificationSessionForMap

ObstacleEnablerNotificationSession getObstacleEnablerNotificationSessionForMap(ObstacleEnablerReceiver obstacleEnablerReceiver,
 Id mapId)
                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

obstacleEnablerReceiver - the notification callback

mapId - the Id of the Map

Returns:

an ObstacleEnablerNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - obstacleEnablerReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getObstacleEnablerMapSession

ObstacleEnablerMapSession getObstacleEnablerMapSession()
                                                throws OperationFailedException

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

Returns:

an ObstacleEnablerMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerMap() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerMap()} is {@code true} .

getObstacleEnablerMapAssignmentSession

ObstacleEnablerMapAssignmentSession getObstacleEnablerMapAssignmentSession()
                                                                    throws OperationFailedException

Gets the OsidSession associated with assigning obstacle enabler to map.

Returns:

an ObstacleEnablerMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerMapAssignment()} is {@code true} .

getObstacleEnablerSmartMapSession

ObstacleEnablerSmartMapSession getObstacleEnablerSmartMapSession(Id mapId)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage obstacle enabler smart map.

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleEnablerSmartMapSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerSmartMap()} is {@code true} .

getObstacleEnablerRuleLookupSession

ObstacleEnablerRuleLookupSession getObstacleEnablerRuleLookupSession()
                                                              throws OperationFailedException

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

Returns:

an ObstacleEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerRuleLookup()} is {@code true} .

getObstacleEnablerRuleLookupSessionForMap

ObstacleEnablerRuleLookupSession getObstacleEnablerRuleLookupSessionForMap(Id mapId)
                                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleEnablerRuleLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getObstacleEnablerRuleApplicationSession

ObstacleEnablerRuleApplicationSession getObstacleEnablerRuleApplicationSession()
                                                                        throws OperationFailedException

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

Returns:

an ObstacleEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerRuleApplication()} is {@code true} .

getObstacleEnablerRuleApplicationSessionForMap

ObstacleEnablerRuleApplicationSession getObstacleEnablerRuleApplicationSessionForMap(Id mapId)
                                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleEnablerRuleApplicationSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .