| Pré. | Proc. |
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 repository
t_objectscenarios
Scenario Attributes
Attribute |
Description |
See also |
|---|---|---|
|
Name |
String Notes: Read/Write The Scenario name. |
|
|
Notes |
String Notes: Read/Write A description of the Scenario, usually containing the steps to execute the scenario. |
|
|
ObjectType |
ObjectType Notes: Read only Distinguishes objects referenced through a Dispatch interface. |
ObjectType |
|
ScenarioGUID |
String Notes: Read/Write A unique ID for the Scenario, used to identify the Scenario unambiguously within a model. |
|
|
Steps |
Collection of ScenarioStep Class Notes: 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. |
Collection Class |
|
Type |
String Notes: Read/Write The scenario type (for example, Basic Path). |
|
|
Weight |
Long Notes: Read/Write Currently used to position scenarios in the scenario list (that is, List Position). |
|
|
XMLContent |
String Notes: 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 |
Description |
See also |
|---|---|---|
|
GetLastError() |
String Notes: Returns a string value describing the most recent error that occurred in relation to this object. |
|
|
Update() |
Boolean Notes: Update the current Scenario object after modification or appending a new item. If False is returned, check the 'GetLastError()' function for more information. |