org.osid.topology.batch

Interface TopologyBatchProxyManager

All Superinterfaces:

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

public interface TopologyBatchProxyManager
extends OsidProxyManager, TopologyBatchProfile

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

• NodeBatchAdminSession: a session to manage nodes in bulk
• EdgeBatchAdminSession: a session to manage edged in bulk
• GraphBatchAdminSession: a session to create, modify and delete Graph in bulk

Method Summary

Methods

Modifier and Type	Method and Description
EdgeBatchAdminSession	getEdgeBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk edge administration service.
EdgeBatchAdminSession	getEdgeBatchAdminSessionForGraph(Id graphId, Proxy proxy) Gets the OsidSession associated with the bulk edge administration service for the given graph.
GraphBatchAdminSession	getGraphBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk graph administration service.
NodeBatchAdminSession	getNodeBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk node administration service.
NodeBatchAdminSession	getNodeBatchAdminSessionForGraph(Id graphId, Proxy proxy) Gets the OsidSession associated with the bulk node administration service for the given graph.

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.topology.batch.TopologyBatchProfile

supportsEdgeBatchAdmin, supportsGraphBatchAdmin, supportsNodeBatchAdmin, 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

getNodeBatchAdminSession

NodeBatchAdminSession getNodeBatchAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk node administration service.

Parameters:

proxy - a proxy

Returns:

a NodeBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeBatchAdmin() is false

Compliance:

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

getNodeBatchAdminSessionForGraph

NodeBatchAdminSession getNodeBatchAdminSessionForGraph(Id graphId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the bulk node administration service for the given graph.

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a NodeBatchAdminSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEdgeBatchAdminSession

EdgeBatchAdminSession getEdgeBatchAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk edge administration service.

Parameters:

proxy - a proxy

Returns:

an EdgeBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeBatchAdmin() is false

Compliance:

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

getEdgeBatchAdminSessionForGraph

EdgeBatchAdminSession getEdgeBatchAdminSessionForGraph(Id graphId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the bulk edge administration service for the given graph.

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

an EdgeBatchAdminSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGraphBatchAdminSession

GraphBatchAdminSession getGraphBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk graph administration service.

Parameters:

proxy - a proxy

Returns:

a GraphBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphBatchAdmin() is false

Compliance:

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