ScenarioStep Class

ScenarioStep Attributes:

Attribute

Type

Notes

See also

Extensions

Collection of ScenarioExtension

Read only

A collection of ScenarioExtension objects that specify how the scenario is extended from this step. The arguments to AddNew should match the name and GUID of the alternative scenario being linked to.

 

Collection

ScenarioExtension

Level

String

Read only

The number of this Step as shown in the scenario editor. This is derived from the value of Pos.

 

 

Link

String

Read/Write

The GUID of a Use Case that is relevant to this step.

 

 

LinkedElement

Element

Read only

The actual element specified by Link, if any.

 

Element

Name

String

Read/Write

The sSep name.

 

 

ObjectType

ObjectType

Read only

Distinguishes objects referenced through a Dispatch interface.

 

ObjectType

Pos

Long

Read/Write

The position of the Step in the Scenario Step list.

 

 

Results

String

Read/Write

Any results that are given from this step.

 

 

State

String

Read/Write

A description of the state the system enters when this Step is executed.

 

 

StepGUID

String

Read/Write

A unique GUID for this Step.

 

 

StepType

ScenarioStepType

Read/Write

Identifies whether this step is being performed by a user or the system.

 

ScenarioStepType

Uses

String

Read/Write

The input and requirements that are relevant to this step.

 

 

UsesElementList

Collection of Element

Read only

Indicates that the Structured Specification tab Uses field is a linked element list.

Collection

Element

Set Up Scenario Specification

 

ScenarioStep 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

Updates the current ScenarioStep object after modification or appending a new item.

If false is returned, check the GetLastError function for more information.