| Interface | osid.topology.batch.TopologyBatchManager | ||
|---|---|---|---|
| Implements | osid.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:
| ||
| Method | getNodeBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.topology.batch.NodeBatchAdminSession | a NodeBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsNodeBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeBatchAdmin()
is true. | |
| Method | getNodeBatchAdminSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
| Return | osid.topology.batch.NodeBatchAdminSession | a NodeBatchAdminSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsNodeBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getEdgeBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.topology.batch.EdgeBatchAdminSession | an EdgeBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsEdgeBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeBatchAdmin()
is true. | |
| Method | getEdgeBatchAdminSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
| Return | osid.topology.batch.EdgeBatchAdminSession | an EdgeBatchAdminSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsEdgeBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getGraphBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.topology.batch.GraphBatchAdminSession | a GraphBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsGraphBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsGraphBatchAdmin()
is true. | |