OSID Logo
OSID Specifications
mapping path batch package
Version 3.1.0
Interfaceosid.mapping.path.batch.MappingPathBatchManager
Implementsosid.OsidManager
osid.mapping.path.batch.MappingPathBatchProfile
Used Byosid.mapping.path.MappingPathManager
Description

The mapping path batch manager provides access to mapping path batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • PathBatchAdminSession: a session to create, modify and delete paths in bulk
  • IntersectionBatchAdminSession: a session to create, modify and delete intersections in bulk
  • SpeedZoneBatchAdminSession: a session to create, modify and delete speed zones in bulk
  • SignalBatchSession: a session to create, modify and delete signals in bulk
  • ObstacleBatchAdminSession: a session to create, modify and delete obstacles in bulk
MethodgetPathBatchAdminSession
Description

Gets the OsidSession associated with the bulk path administration service.

Returnosid.mapping.path.batch.PathBatchAdminSession a PathBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPathBatchAdmin() is false
Complianceoptional This method must be implemented if supportsPathBatchAdmin() is true.
MethodgetPathBatchAdminSessionForMap
Description

Gets the OsidSession associated with the bulk path administration service for the given map.

Parametersosid.id.IdmapId the Id of the Map
Returnosid.mapping.path.batch.PathBatchAdminSession a PathBatchAdminSession
ErrorsNOT_FOUND no Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPathBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPathBatchAdmin() and supportsVisibleFederation() are true
MethodgetIntersectionBatchAdminSession
Description

Gets the OsidSession associated with the bulk intersection administration service.

Returnosid.mapping.path.batch.IntersectionBatchAdminSession an IntersectionBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIntersectionBatchAdmin() is false
Complianceoptional This method must be implemented if supportsIntersectionBatchAdmin() is true.
MethodgetIntersectionBatchAdminSessionForMap
Description

Gets the OsidSession associated with the bulk intersection administration service for the given map.

Parametersosid.id.IdmapId the Id of the Map
Returnosid.mapping.path.batch.IntersectionBatchAdminSession an IntersectionBatchAdminSession
ErrorsNOT_FOUND no Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIntersectionBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsIntersectionBatchAdmin() and supportsVisibleFederation() are true
MethodgetSpeedZoneBatchAdminSession
Description

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

Returnosid.mapping.path.batch.SpeedZoneBatchAdminSession a SpeedZoneBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneBatchAdmin() is false
Complianceoptional This method must be implemented if supportsSpeedZoneBatchAdmin() is true.
MethodgetSpeedZoneBatchAdminSessionForMap
Description

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

Parametersosid.id.IdmapId the Id of the Map
Returnosid.mapping.path.batch.SpeedZoneBatchAdminSession a SpeedZoneBatchAdminSession
ErrorsNOT_FOUND no Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSpeedZoneBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSpeedZoneBatchAdmin() and supportsVisibleFederation() are true
MethodgetSignalBatchAdminSession
Description

Gets the OsidSession associated with the bulk signal administration service.

Returnosid.mapping.path.batch.SignalBatchAdminSession a SignalBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalBatchAdmin() is false
Complianceoptional This method must be implemented if supportsSignalBatchAdmin() is true.
MethodgetSignalBatchAdminSessionForMap
Description

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

Parametersosid.id.IdmapId the Id of the Map
Returnosid.mapping.path.batch.SignalBatchAdminSession a SignalBatchAdminSession
ErrorsNOT_FOUND no Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSignalBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSignalBatchAdmin() and supportsVisibleFederation() are true
MethodgetObstacleBatchAdminSession
Description

Gets the OsidSession associated with the bulk obstacle administration service.

Returnosid.mapping.path.batch.ObstacleBatchAdminSession an ObstacleBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleBatchAdmin() is false
Complianceoptional This method must be implemented if supportsObstacleBatchAdmin() is true.
MethodgetObstacleBatchAdminSessionForMap
Description

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

Parametersosid.id.IdmapId the Id of the Map
Returnosid.mapping.path.batch.ObstacleBatchAdminSession an ObstacleBatchAdminSession
ErrorsNOT_FOUND no Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsObstacleBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsObstacleBatchAdmin() and supportsVisibleFederation() are true