OSID Logo
OSID Specifications
mapping path batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.batch.MappingPathBatchManager
Implementsosid.OsidManager
osid.mapping.path.batch.MappingPathBatchProfile
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.PathBatchAdminSessiona PathBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathBatchAdmin() is false
ComplianceoptionalThis 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.IdmapIdthe Id of the Map
Returnosid.mapping.path.batch.PathBatchAdminSessiona PathBatchAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.IntersectionBatchAdminSessionan IntersectionBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionBatchAdmin() is false
ComplianceoptionalThis 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.IdmapIdthe Id of the Map
Returnosid.mapping.path.batch.IntersectionBatchAdminSessionan IntersectionBatchAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.SpeedZoneBatchAdminSessiona SpeedZoneBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneBatchAdmin() is false
ComplianceoptionalThis 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.IdmapIdthe Id of the Map
Returnosid.mapping.path.batch.SpeedZoneBatchAdminSessiona SpeedZoneBatchAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.SignalBatchAdminSessiona SignalBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalBatchAdmin() is false
ComplianceoptionalThis 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.IdmapIdthe Id of the Map
Returnosid.mapping.path.batch.SignalBatchAdminSessiona SignalBatchAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ObstacleBatchAdminSessionan ObstacleBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleBatchAdmin() is false
ComplianceoptionalThis 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.IdmapIdthe Id of the Map
Returnosid.mapping.path.batch.ObstacleBatchAdminSessionan ObstacleBatchAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleBatchAdmin() and supportsVisibleFederation() are true