org.osid.topology.batch

Interface TopologyBatchManager

All Superinterfaces:

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

public interface TopologyBatchManager
extends OsidManager, TopologyBatchProfile

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

• NodeBatchAdminSession: a session to create, modify and delete Nodes in bulk
• EdgeBatchAdminSession: a session to create, modify and delete Edges in bulk
• GraphBatchAdminSession: a session to create, modify and delete Graph in bulk

Method Summary

Methods

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

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

Gets the OsidSession associated with the bulk node administration service.

Returns:

a NodeBatchAdminSession

Throws:

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

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

Parameters:

graphId - the Id of the Graph

Returns:

a NodeBatchAdminSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk edge administration service.

Returns:

an EdgeBatchAdminSession

Throws:

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

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeBatchAdminSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk graph administration service.

Returns:

a GraphBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphBatchAdmin() is false

Compliance:

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