Book a Demo
Prev Next

ScenarioStep Class

ScenarioStep Attributes

Attribute

Description

See also

Extensions

Collection of ScenarioExtension

Notes: 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 Class ScenarioExtension Class

Level

String

Notes: Read only

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

Link

String

Notes: Read/Write

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

LinkedElement

Element

Notes: Read only

The actual element specified by Link, if any.

Element Class

Name

String

Notes: Read/Write

The step name.

ObjectType

ObjectType

Notes: Read only

Distinguishes objects referenced through a Dispatch interface.

ObjectType

Pos

Long

Notes: Read/Write

The position of the 'Step' in the 'Scenario Step' list.

Results

String

Notes: Read/Write

Any results that are given from this step.

State

String

Notes: Read/Write

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

StepGUID

String

Notes: Read/Write

A unique GUID for this Step.

StepType

ScenarioStepType

Notes: Read/Write

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

ScenarioStepType

Uses

String

Notes: Read/Write

The input and requirements that are relevant to this step.

UsesElementList

Collection of Element

Notes: Read only

Indicates that the Scenarios view 'Uses' field is a linked element list.

Collection Class Element Class Set Up Scenario Specification

ScenarioStep 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: Updates the current ScenarioStep object after modification or appending a new item.

If False is returned, check the 'GetLastError()' function for more information.