Parameter

All Superinterfaces:

Declaration, IdentifiableRemote, NamedObject, java.rmi.Remote, TptRemote
```
public interface Parameter
extends Declaration
```
A parameter can change during a test execution but normally holds the same value most time.

Author:

Copyright (c) 2014-2024 Piketec GmbH - MIT License (MIT) - All rights reserved

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Parameter.ExchangeMode
Defines how parameter values will be exchanged between TPT and the SUT.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Parameter.ExchangeMode`	`getMode()`	Get the exchange mode of the parameter.
`void`	`setMode(Parameter.ExchangeMode mode)`	Sets the exchange mode of the parameter.

Methods inherited from interface com.piketec.tpt.api.Declaration
getDefaultValue, getDescription, getGroup, getType, getUnit, getUnitObject, setDefaultValue, setDescription, setGroup, setType, setUnit, setUnit

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

Methods inherited from interface com.piketec.tpt.api.NamedObject
getName, setName

- Method Detail
  - getMode
```
Parameter.ExchangeMode getMode()
                        throws java.rmi.RemoteException
```
    Get the exchange mode of the parameter.
    
    Returns:
    
    The mode of the parameter.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
    
    See Also:
    
    Parameter.ExchangeMode
  - setMode
```
void setMode(Parameter.ExchangeMode mode)
      throws ApiException,
             java.rmi.RemoteException
```
    Sets the exchange mode of the parameter.
    
    Parameters:
    
    mode - The new exchange mode.
    
    Throws:
    
    ApiException - If the given mode is unknown.
    
    java.rmi.RemoteException - remote communication problem