OSID Logo
OSID Specifications
topology batch package
Version 3.1.0
Interfaceosid.topology.batch.TopologyBatchManager
Implementsosid.OsidManager
osid.topology.batch.TopologyBatchProfile
Used Byosid.topology.TopologyManager
Description

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
MethodgetNodeBatchAdminSession
Description

Gets the OsidSession associated with the bulk node administration service.

Returnosid.topology.batch.NodeBatchAdminSession a NodeBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeBatchAdmin() is false
Complianceoptional This method must be implemented if supportsNodeBatchAdmin() is true.
MethodgetNodeBatchAdminSessionForGraph
Description

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

Parametersosid.id.IdgraphId the Id of the Graph
Returnosid.topology.batch.NodeBatchAdminSession a NodeBatchAdminSession
ErrorsNOT_FOUND no Graph found by the given Id
NULL_ARGUMENT graphId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsNodeBatchAdmin() and supportsVisibleFederation() are true
MethodgetEdgeBatchAdminSession
Description

Gets the OsidSession associated with the bulk edge administration service.

Returnosid.topology.batch.EdgeBatchAdminSession an EdgeBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeBatchAdmin() is false
Complianceoptional This method must be implemented if supportsEdgeBatchAdmin() is true.
MethodgetEdgeBatchAdminSessionForGraph
Description

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

Parametersosid.id.IdgraphId the Id of the Graph
Returnosid.topology.batch.EdgeBatchAdminSession an EdgeBatchAdminSession
ErrorsNOT_FOUND no Graph found by the given Id
NULL_ARGUMENT graphId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEdgeBatchAdmin() and supportsVisibleFederation() are true
MethodgetGraphBatchAdminSession
Description

Gets the OsidSession associated with the bulk graph administration service.

Returnosid.topology.batch.GraphBatchAdminSession a GraphBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphBatchAdmin() is false
Complianceoptional This method must be implemented if supportsGraphBatchAdmin() is true.