All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, TptRemote

All Known Subinterfaces:

CallFunctionStep, ChannelStep, CompareStep, DocumentationStep, ElseIfExprStep, ElseIfStep, ElseStep, EmbeddedSignalStep, EndStep, IfExprStep, IfStep, ImportSignalStep, MessageBoxStep, ParallelStep, ParameterStep, RampStep, ResetAllParameterStep, ResetParameterStep, ResetTargetStep, ServiceStep, TableStep, TestletStep, WaitExprStep, WaitStep, WaitValueStep, WhileExprStep
```
public interface Step
extends IdentifiableRemote
```
A step is one entry in a StepListScenario.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`CALL_FUNCTION`	Type String for call-function-step
`static java.lang.String`	`CHANNEL`	Type String for channel-step
`static java.lang.String`	`COMPARE`	Type String for compare-step
`static java.lang.String`	`DOCUMENTATION`	Type String for documentation-step
`static java.lang.String`	`ELSE`	Type String for else-step
`static java.lang.String`	`ELSE_IF_EXPRESSION`	Type String for else-if-expression-step
`static java.lang.String`	`ELSE_IF_VALUE`	Type String for else-if-value-step
`static java.lang.String`	`EMBEDDED_SIGNAL`	Type String for embedded-signal-step
`static java.lang.String`	`END`	Type String for end-step
`static java.lang.String`	`IF_EXPRESSION`	Type String for if-expression-step
`static java.lang.String`	`IF_VALUE`	Type String for if-value-step
`static java.lang.String`	`IMPORT_SIGNAL`	Type String for import-signal-step
`static java.lang.String`	`MESSAGE_BOX`	Type String for message-box-step
`static java.lang.String`	`PARALLEL`	Type String for parallel-step
`static java.lang.String`	`PARAMETER`	Type String for parameter-step
`static java.lang.String`	`RAMP`	Type String for ramp-step
`static java.lang.String`	`RESET_ALL_PARAMETERS`	Type String for reset-all-parameters-step
`static java.lang.String`	`RESET_PARAMETER`	Type String for reset-parameter-step
`static java.lang.String`	`RESET_TARGET`	Type String for reset-target-step
`static java.lang.String`	`TABLE`	Type String for table-step
`static java.lang.String`	`TESTLET`	Type String for testlet-step
`static java.lang.String`	`WAIT`	Type String for wait-step
`static java.lang.String`	`WAIT_EXPRESSION`	Type String for wait-expression-step
`static java.lang.String`	`WAIT_FOR_VALUE`	Type String for wait-for-value-step
`static java.lang.String`	`WHILE_EXPRESSION`	Type String for while-expression-step

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDocumentation()`
`PropertyMap`	`getProperties()`	Deprecated. Removed in TPT-19.
`StepListScenario`	`getStepList()`
`java.lang.String`	`getType()`
`boolean`	`isActive()`	Determines if this step is enabled.
`void`	`setActive(boolean value)`	Sets if this step is enabled.
`void`	`setDocumentation(java.lang.String documentation)`	TPT offers the possibility to assign some objects comments which are added to the report.
`void`	`setProperties(PropertyMap properties)`	Deprecated. Removed in TPT-19.

Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote
getIdentifier

- Field Detail
  - CALL_FUNCTION
```
static final java.lang.String CALL_FUNCTION
```
    Type String for call-function-step
    
    See Also:
    
    Constant Field Values
  - CHANNEL
```
static final java.lang.String CHANNEL
```
    Type String for channel-step
    
    See Also:
    
    Constant Field Values
  - COMPARE
```
static final java.lang.String COMPARE
```
    Type String for compare-step
    
    See Also:
    
    Constant Field Values
  - DOCUMENTATION
```
static final java.lang.String DOCUMENTATION
```
    Type String for documentation-step
    
    See Also:
    
    Constant Field Values
  - ELSE_IF_EXPRESSION
```
static final java.lang.String ELSE_IF_EXPRESSION
```
    Type String for else-if-expression-step
    
    See Also:
    
    Constant Field Values
  - ELSE_IF_VALUE
```
static final java.lang.String ELSE_IF_VALUE
```
    Type String for else-if-value-step
    
    See Also:
    
    Constant Field Values
  - ELSE
```
static final java.lang.String ELSE
```
    Type String for else-step
    
    See Also:
    
    Constant Field Values
  - EMBEDDED_SIGNAL
```
static final java.lang.String EMBEDDED_SIGNAL
```
    Type String for embedded-signal-step
    
    See Also:
    
    Constant Field Values
  - END
```
static final java.lang.String END
```
    Type String for end-step
    
    See Also:
    
    Constant Field Values
  - IF_EXPRESSION
```
static final java.lang.String IF_EXPRESSION
```
    Type String for if-expression-step
    
    See Also:
    
    Constant Field Values
  - IF_VALUE
```
static final java.lang.String IF_VALUE
```
    Type String for if-value-step
    
    See Also:
    
    Constant Field Values
  - IMPORT_SIGNAL
```
static final java.lang.String IMPORT_SIGNAL
```
    Type String for import-signal-step
    
    See Also:
    
    Constant Field Values
  - MESSAGE_BOX
```
static final java.lang.String MESSAGE_BOX
```
    Type String for message-box-step
    
    See Also:
    
    Constant Field Values
  - PARALLEL
```
static final java.lang.String PARALLEL
```
    Type String for parallel-step
    
    See Also:
    
    Constant Field Values
  - PARAMETER
```
static final java.lang.String PARAMETER
```
    Type String for parameter-step
    
    See Also:
    
    Constant Field Values
  - RAMP
```
static final java.lang.String RAMP
```
    Type String for ramp-step
    
    See Also:
    
    Constant Field Values
  - RESET_ALL_PARAMETERS
```
static final java.lang.String RESET_ALL_PARAMETERS
```
    Type String for reset-all-parameters-step
    
    See Also:
    
    Constant Field Values
  - RESET_PARAMETER
```
static final java.lang.String RESET_PARAMETER
```
    Type String for reset-parameter-step
    
    See Also:
    
    Constant Field Values
  - RESET_TARGET
```
static final java.lang.String RESET_TARGET
```
    Type String for reset-target-step
    
    See Also:
    
    Constant Field Values
  - TABLE
```
static final java.lang.String TABLE
```
    Type String for table-step
    
    See Also:
    
    Constant Field Values
  - TESTLET
```
static final java.lang.String TESTLET
```
    Type String for testlet-step
    
    See Also:
    
    Constant Field Values
  - WAIT_EXPRESSION
```
static final java.lang.String WAIT_EXPRESSION
```
    Type String for wait-expression-step
    
    See Also:
    
    Constant Field Values
  - WAIT
```
static final java.lang.String WAIT
```
    Type String for wait-step
    
    See Also:
    
    Constant Field Values
  - WAIT_FOR_VALUE
```
static final java.lang.String WAIT_FOR_VALUE
```
    Type String for wait-for-value-step
    
    See Also:
    
    Constant Field Values
  - WHILE_EXPRESSION
```
static final java.lang.String WHILE_EXPRESSION
```
    Type String for while-expression-step
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getType
```
java.lang.String getType()
                  throws java.rmi.RemoteException
```
    Returns:
    
    the name of the step type.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - getProperties
```
@Deprecated
PropertyMap getProperties()
                   throws java.rmi.RemoteException
```
    Deprecated.
    Removed in TPT-19. Throws DeprecatedAndRemovedException
    
    Returns a PropertyMap String -> Property that represents all properties of the given step type. A Property is either a Child-PropertyMap, which creates a tree-like structure, or a String value.
    
    Returns:
    
    all properties for the step represented by this object.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - setProperties
```
@Deprecated
void setProperties(PropertyMap properties)
            throws java.rmi.RemoteException
```
    Deprecated.
    Removed in TPT-19. Throws DeprecatedAndRemovedException
    
    Configures the step with the given PropertyMap.
    
    Parameters:
    
    properties - properties to apply this this step
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - setDocumentation
```
void setDocumentation(java.lang.String documentation)
               throws java.rmi.RemoteException
```
    TPT offers the possibility to assign some objects comments which are added to the report. This method provides the possibility to define such a String.
    
    Parameters:
    
    documentation - a String which will be added as a comment to the report.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - getDocumentation
```
java.lang.String getDocumentation()
                           throws java.rmi.RemoteException
```
    Returns:
    
    a String which will be added as a comment to the report.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - getStepList
```
StepListScenario getStepList()
                      throws java.rmi.RemoteException
```
    Returns:
    
    the StepListScenario which contains this step.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - setActive
```
void setActive(boolean value)
        throws java.rmi.RemoteException
```
    Sets if this step is enabled.
    
    Parameters:
    
    value - true if this step is active/enabled
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - isActive
```
boolean isActive()
          throws java.rmi.RemoteException
```
    Determines if this step is enabled.
    
    Returns:
    
    true if this step is active/enabled
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem

Interface Step

Field Summary

Method Summary

Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote

Field Detail

CALL_FUNCTION

CHANNEL

COMPARE

DOCUMENTATION

ELSE_IF_EXPRESSION

ELSE_IF_VALUE

ELSE

EMBEDDED_SIGNAL

END

IF_EXPRESSION

IF_VALUE

IMPORT_SIGNAL

MESSAGE_BOX

PARALLEL

PARAMETER

RAMP

RESET_ALL_PARAMETERS

RESET_PARAMETER

RESET_TARGET

TABLE

TESTLET

WAIT_EXPRESSION

WAIT

WAIT_FOR_VALUE

WHILE_EXPRESSION

Method Detail

getType

getProperties

setProperties

setDocumentation

getDocumentation

getStepList

setActive

isActive