Apama.Services.Scenario Namespace Reference

Classes
class	IllegalCallingThreadException
	Thrown when an attempt is made to change the state of running scenarios in the data queue processing thread. More...
class	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. More...
interface	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). More...
interface	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. More...
interface	IScenarioService
	The Scenario Service is an API for interacting with Apama applications from custom clients and dashboards running outside the correlator. More...
class	ParameterTypeHelper
	A convenience helper class for Apama.Services.Scenario.ParameterType. More...
struct	ScenarioDefinitionConstants
class	ScenarioServiceConfig
	ScenarioServiceConfig is a helper class that assists in building a properties map for use when creating a new ScenarioService via the ScenarioServiceFactory. More...
struct	ScenarioServiceConstants
	Constants used by the Scenario Service. More...
class	ScenarioServiceException
	ScenarioServiceException is a base exception class for all other specialized exceptions within with the Scenario Service. More...
class	ScenarioServiceFactory
	ScenarioServiceFactory is a class that provides factory methods for creating new instances of classes that implement the IScenarioService interface. More...

Enumerations
enum	DiscoveryStatus { DiscoveryStatus.None, DiscoveryStatus.Pending, DiscoveryStatus.Active, DiscoveryStatus.Complete }
	An enumeration to represent the discovery status within the Scenario Service. More...
enum	InstanceState { InstanceState.Running, InstanceState.Ended, InstanceState.Failed }
	Enum to handle the StateChange event. More...
enum	ParameterType {   ParameterType.None, ParameterType.Boolean, ParameterType.Enumeration, ParameterType.Float,   ParameterType.Decimal, ParameterType.Integer, ParameterType.String }
	An enumeration that models the "type" of scenario input/output parameters. More...
enum	ScenarioType { DataView, Query, Unknown }
	Enumeration used to distinguish between different kinds of scenario definition. More...

Enumeration Type Documentation

DiscoveryStatus

enum Apama.Services.Scenario.DiscoveryStatus

strong

An enumeration to represent the discovery status within the Scenario Service.

The possible String value of the states are "Pending", "Active" and "Complete".

The are three static instances of the class, one for each element in the enum.

• None indicates an invalid/unitialised state.
• Pending indicates that the discovery process has not yet started. Possible next states: Active.
• Active indicates that the discovery process has started but is not yet complete. Possible next states: Pending, Complete.
• Complete indicates that the discovery process is complete. Possible next states: Pending.

Enumerator
None	None indicates an invalid/unitialised state.
Pending	Pending indicates that the discovery process has not yet started.
Active	Active indicates that the discovery process has started but is not yet complete.
Complete	Complete indicates that the discovery process is complete.

InstanceState

enum Apama.Services.Scenario.InstanceState

strong

Enum to handle the StateChange event.

The valid states are Running, Ended and Failed.

• Running is the default state when an Instance is created.
• Ended when the instance reaches the END.
• Failed when the instance died unexpectedly.

Enumerator
Running	The default state when an Instance is created.
Ended	The state when the instance reaches the END.
Failed	The state when the instance died unexpectedly.

ParameterType

enum Apama.Services.Scenario.ParameterType

strong

An enumeration that models the "type" of scenario input/output parameters.

For extension and helper methods for this type, see Apama.Services.Scenario.ParameterTypeHelper.

The following table shows the relationship between the Scenario Service, EPL and Java type systems:

Scenario Service Type	EPL Type	.NET Type	Java Type
string	string	System.String	java.lang.String
integer	integer	System.Int64	java.lang.Long
float	float	System.Double	java.lang.Double
decimal	decimal	DecimalFieldValue	DecimalFieldValue
boolean	boolean	System.Boolean	java.lang.Boolean
enumeration	string	System.String	java.lang.String

Enumerator
None	(deprecated) None Type Deprecated - None is not a supported type for scenario variables, and this enumeration member may be removed in a future release. Please do not use.
Boolean	Boolean Type
Enumeration	Enumeration Type
Float	Float Type
Decimal	Decimal Type
Integer	Integer Type
String	String Type

ScenarioType

enum Apama.Services.Scenario.ScenarioType

strong

Enumeration used to distinguish between different kinds of scenario definition.