OSID Logo
OSID Specifications
topology batch package
Version 3.1.0
Interfaceosid.topology.batch.TopologyBatchProxyManager
Implementsosid.OsidProxyManager
osid.topology.batch.TopologyBatchProfile
Used Byosid.topology.TopologyProxyManager
Description

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

Gets the OsidSession associated with the bulk node administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.batch.NodeBatchAdminSession a NodeBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxy a proxy
Returnosid.topology.batch.NodeBatchAdminSession a NodeBatchAdminSession
ErrorsNOT_FOUND no Graph found by the given Id
NULL_ARGUMENT graphId or proxy 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.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.batch.EdgeBatchAdminSession an EdgeBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxy a proxy
Returnosid.topology.batch.EdgeBatchAdminSession an EdgeBatchAdminSession
ErrorsNOT_FOUND no Graph found by the given Id
NULL_ARGUMENT graphId or proxy 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.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.batch.GraphBatchAdminSession a GraphBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphBatchAdmin() is false
Complianceoptional This method must be implemented if supportsGraphBatchAdmin() is true.