org.osid.mapping.batch

Interface MappingBatchManager

All Superinterfaces:

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

public interface MappingBatchManager
extends OsidManager, MappingBatchProfile

The mapping batch manager provides access to mapping batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• LocationBatchAdminSession: a session to create, modify and delete locations in bulk
• MapBatchAdminSession: a session to create, modify and delete maps in bulk

Method Summary

Methods

Modifier and Type	Method and Description
LocationBatchAdminSession	getLocationBatchAdminSession() Gets the OsidSession associated with the bulk location administration service.
LocationBatchAdminSession	getLocationBatchAdminSessionForMap(Id mapId) Gets the OsidSession associated with the bulk location administration service for the given map.
MapBatchAdminSession	getMapBatchAdminSession() Gets the OsidSession associated with the bulk map administration service.

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.batch.MappingBatchProfile

supportsLocationBatchAdmin, supportsMapBatchAdmin, 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

getLocationBatchAdminSession

LocationBatchAdminSession getLocationBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk location administration service.

Returns:

a LocationBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationBatchAdmin() is false

Compliance:

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

getLocationBatchAdminSessionForMap

LocationBatchAdminSession getLocationBatchAdminSessionForMap(Id mapId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a LocationBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getMapBatchAdminSession

MapBatchAdminSession getMapBatchAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the bulk map administration service.

Returns:

a MapBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMapBatchAdmin() is false

Compliance:

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