org.osid.mapping.path.batch

Interface MappingPathBatchProxyManager

All Superinterfaces:

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

public interface MappingPathBatchProxyManager
extends OsidProxyManager, MappingPathBatchProfile

The mapping path batch proxy manager provides access to mapping path batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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(Proxy proxy) Gets the OsidSession associated with the bulk intersection administration service.
IntersectionBatchAdminSession	getIntersectionBatchAdminSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the bulk intersection administration service for the given map.
ObstacleBatchAdminSession	getObstacleBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk obstacle administration service.
ObstacleBatchAdminSession	getObstacleBatchAdminSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the bulk obstacle administration service for the given map.
PathBatchAdminSession	getPathBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk path administration service.
PathBatchAdminSession	getPathBatchAdminSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the bulk path administration service for the given map.
SignalBatchAdminSession	getSignalBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk signal administration service.
SignalBatchAdminSession	getSignalBatchAdminSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the bulk signal administration service for the given map.
SpeedZoneBatchAdminSession	getSpeedZoneBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk speed zone administration service.
SpeedZoneBatchAdminSession	getSpeedZoneBatchAdminSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the bulk speed zone administration service for the given map.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk path administration service.

Parameters:

proxy - a proxy

Returns:

a PathBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a PathBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy 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(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk intersection administration service.

Parameters:

proxy - a proxy

Returns:

an IntersectionBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

an IntersectionBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy 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(Proxy proxy)
                                                         throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a SpeedZoneBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               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

proxy - a proxy

Returns:

a SpeedZoneBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk signal administration service.

Parameters:

proxy - a proxy

Returns:

a SignalBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a SignalBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk obstacle administration service.

Parameters:

proxy - a proxy

Returns:

an ObstacleBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

an ObstacleBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy 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