Apama API Reference for .NET
10.3.1.5
|
IScenarioInstance is the public interface for a class that represents a Scenario instance. More...
Public Member Functions | |
void | AddListener (PropertyChangedEventHandler listener) |
Add a listener to the list of those interested in changes to any object property, or any scenario instance (input and/or output) parameter. More... | |
void | AddListener (string propertyName, PropertyChangedEventHandler listener) |
Add a listener to the list of those interested in changes to the object property with given name, or the scenario instance (input and/or output) parameter with the given name. More... | |
bool | Delete () |
Delete this instance. More... | |
object | GetValue (string parameterName) |
Get the value of a single specific (input or output) parameter of this instance. More... | |
void | RemoveListener (PropertyChangedEventHandler listener) |
Remove a listener from the list of those interested in changes to any object property, or scenario instance parameter. More... | |
void | RemoveListener (string propertyName, PropertyChangedEventHandler listener) |
Remove a listener from the list of those interested in changes to the object property with given name, or the scenario instance parameter with the given name. More... | |
bool | SetValue (string parameterName, object value) |
Set the value of a single specific (input) parameter of this instance. More... | |
bool | SetValues (Dictionary< string, object > valuesMap) |
Set several (input) parameter values of this instance. More... | |
Properties | |
long | Id [get] |
Get the Id of the instance. More... | |
long | LastUpdateTime [get] |
Get the timestamp (milliseconds) of the last known update event for this instance. The folloing events will set an update time - Created, Edited, Update. More... | |
string | Owner [get] |
Get the owner (username) of the instance. More... | |
IScenarioDefinition | ScenarioDefinition [get] |
Get the Scenario Definition. More... | |
InstanceState | State [get] |
Get the current state of the instance. More... | |
IScenarioInstance is the public interface for a class that represents a Scenario instance.
This API provides a mechanism to access the values of individual parameters, and to delete the instance. It is also possible to determine the timestamp of the last received Update event.
void Apama.Services.Scenario.IScenarioInstance.AddListener | ( | PropertyChangedEventHandler | listener | ) |
Add a listener to the list of those interested in changes to any object property, or any scenario instance (input and/or output) parameter.
listener | property change listener to invoke when a property or parameter changes value. |
void Apama.Services.Scenario.IScenarioInstance.AddListener | ( | string | propertyName, |
PropertyChangedEventHandler | listener | ||
) |
Add a listener to the list of those interested in changes to the object property with given name, or the scenario instance (input and/or output) parameter with the given name.
propertyName | name of the property or parameter to register interest in. |
listener | property change listener to invoke when a property or parameter changes value. |
bool Apama.Services.Scenario.IScenarioInstance.Delete | ( | ) |
Delete this instance.
IllegalCallingThreadException | if called from the data processing thread (i.e. from a PropertyChangeListener listening to an instance or definition). |
object Apama.Services.Scenario.IScenarioInstance.GetValue | ( | string | parameterName | ) |
Get the value of a single specific (input or output) parameter of this instance.
parameterName | The name of the parameter to be retrieved. |
void Apama.Services.Scenario.IScenarioInstance.RemoveListener | ( | PropertyChangedEventHandler | listener | ) |
Remove a listener from the list of those interested in changes to any object property, or scenario instance parameter.
listener | property change listener to remove from the interest list. |
void Apama.Services.Scenario.IScenarioInstance.RemoveListener | ( | string | propertyName, |
PropertyChangedEventHandler | listener | ||
) |
Remove a listener from the list of those interested in changes to the object property with given name, or the scenario instance parameter with the given name.
propertyName | name of the property or parameter to remove interest in. |
listener | property change listener to remove from the interest list. |
bool Apama.Services.Scenario.IScenarioInstance.SetValue | ( | string | parameterName, |
object | value | ||
) |
Set the value of a single specific (input) parameter of this instance.
parameterName | The name of the parameter to be set. |
value | The new value. |
true if edit was successful, false otherwise.
InvalidInputParameterException | when value is invalid. Note that future versions of this API may also throw this exception to indicate constraint violations. |
IllegalCallingThreadException | if called from the data processing thread (i.e. from a PropertyChangeListener listening to an instance or definition). |
bool Apama.Services.Scenario.IScenarioInstance.SetValues | ( | Dictionary< string, object > | valuesMap | ) |
Set several (input) parameter values of this instance.
valuesMap | a Map (key String parameterName : value Object) of the values to be set in this instance. |
true if edit was successful, false otherwise.
InvalidInputParameterException | when any value in the valuesMap is invalid. Note that future versions of this API may also throw this exception to indicate constraint violations. |
IllegalCallingThreadException | if called from the data processing thread (i.e. from a PropertyChangeListener listening to an instance or definition). |
|
get |
Get the Id of the instance.
|
get |
Get the timestamp (milliseconds) of the last known update event for this instance. The folloing events will set an update time - Created, Edited, Update.
|
get |
Get the owner (username) of the instance.
|
get |
|
get |
Get the current state of the instance.
for list of states