Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.
Scenario Class
A Scenario corresponds to a Collaboration or Use Case instance. Each Scenario is a path of execution through the logic of a Use Case. Scenarios can be added to using the Element Scenarios collection.
Associated table in .EAP file: t_objectscenarios
Scenario Attributes
Attribute |
Type |
Notes |
See Also |
|---|---|---|---|
Name |
String |
Read/Write. The Scenario name. |
|
Notes |
String |
Read/Write. Description of the Scenario. Usually contains the steps to execute the scenario. |
|
ObjectType |
Read only. Distinguishes objects referenced through a Dispatch interface. |
|
|
ScenarioGUID |
String |
Read/Write. A unique ID for the Scenario. Used to identify the Scenario unambiguously within a model. |
|
Collection of ScenarioStep |
Read only. A collection of step objects for this Scenario. Use the AddNew and Delete functions to manage steps. AddNew passes the step name and "1" as the type for an actor step. |
||
Type |
String |
Read/Write. The scenario type (for example, Basic Path). |
|
Weight |
Long |
Read/Write. Currently used to position scenarios in the scenario list (that is, List Position). |
|
XMLContent |
String |
Read/Write. A structured field that can contain scenario details in XML format. It is recommended that you use the Steps collection to read or modify this field. |
|
Scenario Methods
Method |
Type |
Notes |
|---|---|---|
GetLastError () |
String |
Returns a string value describing the most recent error that occurred in relation to this object. This function is rarely used as an exception is thrown when an error occurs. |
Update () |
Boolean |
Update the current Scenario object after modification or appending a new item. If false is returned, check the GetLastError function for more information. |
