Package com.piketec.tpt.api.steplist

Interface CallFunctionStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, Step, TptRemote

public interface CallFunctionStep
extends Step

This Step provides the possibility to call a TPT function during test execution.

Field Summary

Fields inherited from interface com.piketec.tpt.api.steplist.Step

CALL_FUNCTION, CHANNEL, COMPARE, DOCUMENTATION, ELSE, ELSE_IF_EXPRESSION, ELSE_IF_VALUE, EMBEDDED_SIGNAL, END, IF_EXPRESSION, IF_VALUE, IMPORT_SIGNAL, MESSAGE_BOX, PARALLEL, PARAMETER, RAMP, RESET_ALL_PARAMETERS, RESET_PARAMETER, RESET_TARGET, TABLE, TESTLET, WAIT, WAIT_EXPRESSION, WAIT_FOR_VALUE, WHILE_EXPRESSION

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFunctionCall()
java.lang.String	getOutputSignal()
boolean	isAlways()
void	setAlways(boolean value)	Determines if this step should run "always".
void	setFunctionCall(java.lang.String call)	Sets the "Call function" expression, which will run through test execution.
void	setOutputSignal(java.lang.String signal)	Sets the output signal to store the function result.

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

getIdentifier

Methods inherited from interface com.piketec.tpt.api.steplist.Step

getDocumentation, getProperties, getStepList, getType, isActive, setActive, setDocumentation, setProperties

Method Detail

getFunctionCall

java.lang.String getFunctionCall()
                          throws java.rmi.RemoteException

Returns:

the "Call function" expression, which will run through test execution.

Throws:

java.rmi.RemoteException - remote communication problem

setFunctionCall

void setFunctionCall(java.lang.String call)
              throws java.rmi.RemoteException

Sets the "Call function" expression, which will run through test execution.

Parameters:

call - actual function call expression

Throws:

java.rmi.RemoteException - remote communication problem

getOutputSignal

java.lang.String getOutputSignal()
                          throws java.rmi.RemoteException

Returns:

the output signal to store the function result.

Throws:

java.rmi.RemoteException - remote communication problem

setOutputSignal

void setOutputSignal(java.lang.String signal)
              throws java.rmi.RemoteException

Sets the output signal to store the function result.

Parameters:

signal - name to use as output channel

Throws:

java.rmi.RemoteException - remote communication problem

isAlways

boolean isAlways()
          throws java.rmi.RemoteException

Returns:

true if this step should run "always".

Throws:

java.rmi.RemoteException - remote communication problem

setAlways

void setAlways(boolean value)
        throws java.rmi.RemoteException

Determines if this step should run "always".

Parameters:

value - true to use always semantics

Throws:

java.rmi.RemoteException - remote communication problem