org.osid.mapping.batch

Interface MappingBatchProxyManager

All Superinterfaces:

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

public interface MappingBatchProxyManager
extends OsidProxyManager, MappingBatchProfile

The mapping batch proxy manager provides access to mapping 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:

• 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(Proxy proxy) Gets the OsidSession associated with the bulk location administration service.
LocationBatchAdminSession	getLocationBatchAdminSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the bulk location administration service for the given map.
MapBatchAdminSession	getMapBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk map administration service.

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

Gets the OsidSession associated with the bulk location administration service.

Parameters:

proxy - a proxy

Returns:

a LocationBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationBatchAdminSession

Throws:

NotFoundException - no Map found by the given Id

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

Gets the OsidSession associated with the bulk map administration service.

Parameters:

proxy - a proxy

Returns:

a MapBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapBatchAdmin() is false

Compliance:

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