Interface | osid.mapping.path.batch.MappingPathBatchManager | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getPathBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.mapping.path.batch.PathBatchAdminSession | a PathBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPathBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPathBatchAdmin()
is true. | |
Method | getPathBatchAdminSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | osid.mapping.path.batch.PathBatchAdminSession | a PathBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsPathBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getIntersectionBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.mapping.path.batch.IntersectionBatchAdminSession | an IntersectionBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIntersectionBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsIntersectionBatchAdmin()
is true. | |
Method | getIntersectionBatchAdminSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | osid.mapping.path.batch.IntersectionBatchAdminSession | an IntersectionBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsIntersectionBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getSpeedZoneBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.mapping.path.batch.SpeedZoneBatchAdminSession | a SpeedZoneBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSpeedZoneBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSpeedZoneBatchAdmin()
is true. | |
Method | getSpeedZoneBatchAdminSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | osid.mapping.path.batch.SpeedZoneBatchAdminSession | a SpeedZoneBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsSpeedZoneBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getSignalBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.mapping.path.batch.SignalBatchAdminSession | a SignalBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSignalBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSignalBatchAdmin()
is true. | |
Method | getSignalBatchAdminSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | osid.mapping.path.batch.SignalBatchAdminSession | a SignalBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsSignalBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getObstacleBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.mapping.path.batch.ObstacleBatchAdminSession | an ObstacleBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsObstacleBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsObstacleBatchAdmin()
is true. | |
Method | getObstacleBatchAdminSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | osid.mapping.path.batch.ObstacleBatchAdminSession | an ObstacleBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsObstacleBatchAdmin()
and supportsVisibleFederation() are true |