Interface MappingPathBatchManager

All Superinterfaces:

AutoCloseable, Closeable, MappingPathBatchProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface MappingPathBatchProfile

supportsIntersectionBatchAdmin, supportsObstacleBatchAdmin, supportsPathBatchAdmin, supportsSignalBatchAdmin, supportsSpeedZoneBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsIntersectionBatchAdmin()	Tests if bulk administration of intersections is available.
boolean	supportsObstacleBatchAdmin()	Tests if bulk administration of obstacles is available.
boolean	supportsPathBatchAdmin()	Tests if bulk administration of paths is available.
boolean	supportsSignalBatchAdmin()	Tests if bulk administration of signals is available.
boolean	supportsSpeedZoneBatchAdmin()	Tests if bulk administration of speed zones is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsPathBatchAdmin()} is {@code 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 {@code supportsPathBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsIntersectionBatchAdmin()} is {@code 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 {@code supportsIntersectionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSpeedZoneBatchAdmin()} is {@code 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 {@code supportsSpeedZoneBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSignalBatchAdmin()} is {@code 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 {@code supportsSignalBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsObstacleBatchAdmin()} is {@code 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 {@code supportsObstacleBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}