org.osid.mapping.path.batch

Interface MappingPathBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MappingPathBatchProfile, OsidManager, OsidProfile, Sourceable

public interface MappingPathBatchManager
extends OsidManager, MappingPathBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
IntersectionBatchAdminSession	getIntersectionBatchAdminSession() Gets the OsidSession associated with the bulk intersection administration service.
IntersectionBatchAdminSession	getIntersectionBatchAdminSessionForMap(Id mapId) Gets the OsidSession associated with the bulk intersection administration service for the given map.
ObstacleBatchAdminSession	getObstacleBatchAdminSession() Gets the OsidSession associated with the bulk obstacle administration service.
ObstacleBatchAdminSession	getObstacleBatchAdminSessionForMap(Id mapId) Gets the OsidSession associated with the bulk obstacle administration service for the given map.
PathBatchAdminSession	getPathBatchAdminSession() Gets the OsidSession associated with the bulk path administration service.
PathBatchAdminSession	getPathBatchAdminSessionForMap(Id mapId) Gets the OsidSession associated with the bulk path administration service for the given map.
SignalBatchAdminSession	getSignalBatchAdminSession() Gets the OsidSession associated with the bulk signal administration service.
SignalBatchAdminSession	getSignalBatchAdminSessionForMap(Id mapId) Gets the OsidSession associated with the bulk signal administration service for the given map.
SpeedZoneBatchAdminSession	getSpeedZoneBatchAdminSession() Gets the OsidSession associated with the bulk speed zone administration service.
SpeedZoneBatchAdminSession	getSpeedZoneBatchAdminSessionForMap(Id mapId) Gets the OsidSession associated with the bulk speed zone administration service for the given map.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.mapping.path.batch.MappingPathBatchProfile

supportsIntersectionBatchAdmin, supportsObstacleBatchAdmin, supportsPathBatchAdmin, supportsSignalBatchAdmin, supportsSpeedZoneBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPathBatchAdminSession

PathBatchAdminSession getPathBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk path administration service.

Returns:

a PathBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsPathBatchAdmin() is true.

getPathBatchAdminSessionForMap

PathBatchAdminSession getPathBatchAdminSessionForMap(Id mapId)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a PathBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPathBatchAdmin() and supportsVisibleFederation() are true

getIntersectionBatchAdminSession

IntersectionBatchAdminSession getIntersectionBatchAdminSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk intersection administration service.

Returns:

an IntersectionBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsIntersectionBatchAdmin() is true.

getIntersectionBatchAdminSessionForMap

IntersectionBatchAdminSession getIntersectionBatchAdminSessionForMap(Id mapId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an IntersectionBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsIntersectionBatchAdmin() and supportsVisibleFederation() are true

getSpeedZoneBatchAdminSession

SpeedZoneBatchAdminSession getSpeedZoneBatchAdminSession()
                                                         throws OperationFailedException

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

Returns:

a SpeedZoneBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsSpeedZoneBatchAdmin() is true.

getSpeedZoneBatchAdminSessionForMap

SpeedZoneBatchAdminSession getSpeedZoneBatchAdminSessionForMap(Id mapId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSpeedZoneBatchAdmin() and supportsVisibleFederation() are true

getSignalBatchAdminSession

SignalBatchAdminSession getSignalBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk signal administration service.

Returns:

a SignalBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsSignalBatchAdmin() is true.

getSignalBatchAdminSessionForMap

SignalBatchAdminSession getSignalBatchAdminSessionForMap(Id mapId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSignalBatchAdmin() and supportsVisibleFederation() are true

getObstacleBatchAdminSession

ObstacleBatchAdminSession getObstacleBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk obstacle administration service.

Returns:

an ObstacleBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsObstacleBatchAdmin() is true.

getObstacleBatchAdminSessionForMap

ObstacleBatchAdminSession getObstacleBatchAdminSessionForMap(Id mapId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsObstacleBatchAdmin() and supportsVisibleFederation() are true