edu.ksu.cis.cadena.core.specification.scenario
Interface Scenario

All Superinterfaces:

CalmObject

public interface Scenario
extends CalmObject

A representation of the model object 'Scenario'.

The following features are supported:

• Name
• Connectors
• Component Instances
• Scenario Instances
• Style
• Imports
• Open Ports
• Open Properties

See Also:

ScenarioPackage.getScenario()

Method Summary

java.util.List<Pair<OpenPropertyDeclaration,OpenPropertyBinding>>	findOpenProperty(PropertyDeclaration property, DirectPropertyContainer container, Port port)
java.util.Collection<Scenario>	getAllChildren() Finds all Scenarios that are contained within this scenario (and all of this scenario's children) as scenario instances.
java.util.List<Instance>	getAllInstances()
EList	getComponentInstances() Returns the value of the 'Component Instances' containment reference list.
EList	getConnectors() Returns the value of the 'Connectors' containment reference list.
EList	getImports() Returns the value of the 'Imports' reference list.
java.lang.String	getName() Returns the value of the 'Name' attribute.
EList	getOpenPorts() Returns the value of the 'Open Ports' containment reference list.
EList	getOpenProperties() Returns the value of the 'Open Properties' containment reference list.
EList	getScenarioInstances() Returns the value of the 'Scenario Instances' containment reference list.
Style	getStyle() Returns the value of the 'Style' reference.
java.util.List<ComponentInstance>	getTypedComponentInstances()
java.util.List<Connector>	getTypedConnectors()
java.util.List<Module>	getTypedImports()
java.util.List<ScenarioPort>	getTypedOpenPorts()
java.util.List<OpenPropertyDeclaration>	getTypedOpenProperties()
java.util.List<ScenarioInstance>	getTypedScenarioInstances()
java.util.List<ComponentType>	getVisibleComponentTypes(boolean includeAbstract) Finds all of the visible component type for this Style.
void	setName(java.lang.String value) Sets the value of the 'Name' attribute.
void	setStyle(Style value) Sets the value of the 'Style' reference.

Methods inherited from interface edu.ksu.cis.cadena.core.specification.base.CalmObject

addBackReference, getBackReferences, getDeleted, getTrashCan, getUuid, removeBackReference

Method Detail

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), ScenarioPackage.getScenario_Name()

setName

void setName(java.lang.String value)

Sets the value of the 'Name' attribute.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

getName()

getConnectors

EList getConnectors()

Returns the value of the 'Connectors' containment reference list. The list contents are of type Connector. It is bidirectional and its opposite is 'Scenario'.

If the meaning of the 'Connectors' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Connectors' containment reference list.

See Also:

ScenarioPackage.getScenario_Connectors(), Connector.getScenario()

getComponentInstances

EList getComponentInstances()

Returns the value of the 'Component Instances' containment reference list. The list contents are of type ComponentInstance. It is bidirectional and its opposite is 'Scenario'.

If the meaning of the 'Component Instances' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Component Instances' containment reference list.

See Also:

ScenarioPackage.getScenario_ComponentInstances(), ComponentInstance.getScenario()

getScenarioInstances

EList getScenarioInstances()

Returns the value of the 'Scenario Instances' containment reference list. The list contents are of type ScenarioInstance. It is bidirectional and its opposite is 'Scenario'.

If the meaning of the 'Scenario Instances' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Scenario Instances' containment reference list.

See Also:

ScenarioPackage.getScenario_ScenarioInstances(), ScenarioInstance.getScenario()

getStyle

Style getStyle()

Returns the value of the 'Style' reference.

If the meaning of the 'Style' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Style' reference.

See Also:

setStyle(Style), ScenarioPackage.getScenario_Style()

setStyle

void setStyle(Style value)

Sets the value of the 'Style' reference.

Parameters:

value - the new value of the 'Style' reference.

See Also:

getStyle()

getImports

EList getImports()

Returns the value of the 'Imports' reference list. The list contents are of type Module.

If the meaning of the 'Imports' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Imports' reference list.

See Also:

ScenarioPackage.getScenario_Imports()

getOpenPorts

EList getOpenPorts()

Returns the value of the 'Open Ports' containment reference list. The list contents are of type ScenarioPort.

If the meaning of the 'Open Ports' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Open Ports' containment reference list.

See Also:

ScenarioPackage.getScenario_OpenPorts()

getOpenProperties

EList getOpenProperties()

Returns the value of the 'Open Properties' containment reference list. The list contents are of type OpenPropertyDeclaration.

If the meaning of the 'Open Properties' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Open Properties' containment reference list.

See Also:

ScenarioPackage.getScenario_OpenProperties()

getTypedImports

java.util.List<Module> getTypedImports()

getTypedOpenPorts

java.util.List<ScenarioPort> getTypedOpenPorts()

getTypedScenarioInstances

java.util.List<ScenarioInstance> getTypedScenarioInstances()

getTypedConnectors

java.util.List<Connector> getTypedConnectors()

getTypedComponentInstances

java.util.List<ComponentInstance> getTypedComponentInstances()

getTypedOpenProperties

java.util.List<OpenPropertyDeclaration> getTypedOpenProperties()

getAllInstances

java.util.List<Instance> getAllInstances()

getVisibleComponentTypes

java.util.List<ComponentType> getVisibleComponentTypes(boolean includeAbstract)

Finds all of the visible component type for this Style. The contents of all the directly (but not indirectly) imported modules are included.

Parameters:

includeAbstract - if true, exclude component types that are abstract

Returns:

The found component types

getAllChildren

java.util.Collection<Scenario> getAllChildren()

Finds all Scenarios that are contained within this scenario (and all of this scenario's children) as scenario instances.

Returns:

The found Scenarios

findOpenProperty

java.util.List<Pair<OpenPropertyDeclaration,OpenPropertyBinding>> findOpenProperty(PropertyDeclaration property,
                                                                                   DirectPropertyContainer container,
                                                                                   Port port)