OSID Logo
OSID Specifications
topology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.batch.TopologyBatchManager
Implementsosid.OsidManager
osid.topology.batch.TopologyBatchProfile
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.NodeBatchAdminSessiona NodeBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsNodeBatchAdmin() is false
ComplianceoptionalThis 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.IdgraphIdthe Id of the Graph
Returnosid.topology.batch.NodeBatchAdminSessiona NodeBatchAdminSession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsNodeBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.EdgeBatchAdminSessionan EdgeBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeBatchAdmin() is false
ComplianceoptionalThis 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.IdgraphIdthe Id of the Graph
Returnosid.topology.batch.EdgeBatchAdminSessionan EdgeBatchAdminSession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.GraphBatchAdminSessiona GraphBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsGraphBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsGraphBatchAdmin() is true.