EnterprisePlugin

All Known Subinterfaces:: BatchEnterprisePlugin

All Known Implementing Classes:: BatchEnterprisePluginClient, InteractiveEnterprisePluginClient

public interface EnterprisePlugin

Enterprise plugin features

The following exception sub-classes of EnterprisePluginException can be thrown by all methods of this client:

UnauthorizedApiCallException: invalid authentication token
ForbiddenApiCallException: authentication token with insufficient privileges
ApiCallIOException: unexpected IO error
InvalidApiCallException: invalid input data

Method Summary

Modifier and Type

Method

Description

boolean

abortRun(UUID runId)

RunSummary

startSimulation(String simulationName, DeploymentInfo deploymentInfo, RunComment runComment)

SimulationEndResult

waitForRunEnd(RunSummary startedRun)

Method Details
- startSimulation
  
  RunSummary startSimulation(String simulationName, DeploymentInfo deploymentInfo, RunComment runComment) throws EnterprisePluginException
  
  Throws:
  
  EnterprisePluginException
- waitForRunEnd
  
  SimulationEndResult waitForRunEnd(RunSummary startedRun) throws EnterprisePluginException
  
  Parameters:
  
  startedRun - Required
  
  Throws:
  
  EnterprisePluginException
- abortRun
  
  boolean abortRun(UUID runId) throws EnterprisePluginException
  
  Parameters:
  
  runId - Required
  
  Returns:
  
  false if there was no run to abort (run does not exist or is already stopped)
  
  Throws:
  
  EnterprisePluginException