Developing Apama Applications > Developing Clients > The ScenarioService API > The IScenarioInstance interface
The IScenarioInstance interface
A class that implements the IScenarioInstance class represents an instance of a scenario. The class has methods to query and change the value of any of its parameters. It also contains methods to add and remove listeners and a method to delete the instance. The full set of methods is as follows:
*void addListener(java.beans.PropertyChangeListener 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.
*void addListener() - defined as:

void addListener(
java.lang.String propertyName,
java.beans.PropertyChangeListener 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.
*boolean delete()
Delete this instance.
*java.lang.Long getId()
Get the ID of the instance.
*long getLastUpdateTime()
Get the timestamp (milliseconds) of the last known update event for this instance.
*java.lang.String getOwner()
Get the owner (username) of the instance.
*IScenarioDefinition getScenarioDefinition()
Get the scenario definition.
*InstanceStateEnum getState()
Get the current state of the instance.
*java.lang.Object getValue(java.lang.String parameterName)
Get the value of a single specific (input or output) parameter of this instance.
*void removeListener(java.beans.PropertyChangeListener listener)
Remove a listener from the list of those interested in changes to any object property, or scenario instance parameter.
*void removeListener() — defined as:

void removeListener(
java.lang.String propertyName,
java.beans.PropertyChangeListener 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.
*boolean setValue() — defined as:

boolean setValue(
java.lang.String parameterName,
java.lang.Object value)
Set the value of a single specific (input) parameter of this instance.
*boolean setValues(java.util.Map<String, Object> valuesMap)
Set several (input) parameter values of this instance.
Copyright © 2013 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors.