Package com.apama.services.scenario
-
Interface Summary Interface Description IScenarioDefinition IScenarioDefinition supports creating instances of a scenario, listening for added/removed/changed instances, and getting the information about the scenario definition itself (for example id, display name, input/output parameter names and types).IScenarioInstance IScenarioInstance supports getting the owner, last update time and current input/output parameter values of a scenario instance, listening for changes in individual instance parameters, and performing delete and edit operations on the instance.IScenarioService The Scenario Service is an API for interacting with Apama applications from custom clients and dashboards running outside the correlator. -
Class Summary Class Description ScenarioServiceConfig ScenarioServiceConfig is a helper class that assists in building a properties map for use when creating a new ScenarioService via the ScenarioServiceFactory.ScenarioServiceFactory ScenarioServiceFactory is a class that provides factory methods for creating new instances of IScenarioService. -
Enum Summary Enum Description DiscoveryStatusEnum Enum to represent the discovery status within the Scenario Service.InstanceStateEnum Enum class to handle the StateChange event.IScenarioDefinition.ScenarioType Enumeration used to distinguish between different kinds of scenario definition.ParameterTypeEnum Enumeration class to model the "type" of scenario input/output parameters. -
Exception Summary Exception Description IllegalCallingThreadException Thrown when an attempt is made to change the state of running scenarios in the data queue processing thread.InvalidInputParameterException InvalidInputParameterException is a specialized exception class that is used by classes of the Scenario Service to indicate that an invalid input parameter has been provided to create or edit a ScenarioInstance.ScenarioServiceException ScenarioServiceException is a base exception class for all other specialized exceptions within with the Scenario Service.