Scenario

Return to Introduction  Previous page  Next page

public 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

Name

String

Read/Write.  The Scenario name. 

Type

String

Read/Write.  The Scenario type (eg. Basic Path).

Weight

Long

Read/Write.  Currently used to position scenarios in the scenario list (ie. List Position).

Notes

String

Read/Write.  Description of the Scenario. Usually contains the steps to execute the scenario.

XMLContent

String

Read/Write.  A structured field that can contain scenario details in XML format.

ScenarioGUID

String

Read/Write.  A unique ID for the scenario. Used to identify the scenario unambiguously within a model.

ObjectType

ObjectType

Read only.  Distinguishes objects referenced through a Dispatch interface.

Scenario Methods

Method

Type

Notes

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.

GetLastError () 

String

Returns a string value describing the most recent error that occurred in relation to this object.

This function is rarely used since an exception is thrown when an error occurs.