Package com.piketec.tpt.api.steplist

Interface MessageBoxStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, Step, TptRemote

public interface MessageBoxStep
extends Step

This Step provides the possibility to open a message box during the test execution.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MessageBoxStep.MessageBoxType	A message box has a type (OK,YES/NO, NO BUTTON), depending of its role during the 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	getChannel()
java.lang.String	getCondition()
java.lang.String	getMessage()
MessageBoxStep.MessageBoxType	getMessageBoxType()
void	setChannel(java.lang.String channel)	Sets the result channel.
void	setCondition(java.lang.String condition)	Sets the termination condition for this message box.
void	setMessage(java.lang.String message)	Set the message of this message box.
void	setMessageBoxType(MessageBoxStep.MessageBoxType type)	Sets the type of this message box.

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

getMessage

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

Returns:

the message of this message box.

Throws:

java.rmi.RemoteException - remote communication problem

setMessage

void setMessage(java.lang.String message)
         throws java.rmi.RemoteException

Set the message of this message box.

Parameters:

message - the message to use

Throws:

java.rmi.RemoteException - remote communication problem

getChannel

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

Returns:

the result channel.

Throws:

java.rmi.RemoteException - remote communication problem

setChannel

void setChannel(java.lang.String channel)
         throws java.rmi.RemoteException

Sets the result channel.

Parameters:

channel - the channel to assign the result to

Throws:

java.rmi.RemoteException - remote communication problem

getCondition

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

Returns:

the termination condition for this message box.

Throws:

java.rmi.RemoteException - remote communication problem

setCondition

void setCondition(java.lang.String condition)
           throws java.rmi.RemoteException

Sets the termination condition for this message box.

Parameters:

condition - termination condition

Throws:

java.rmi.RemoteException - remote communication problem

getMessageBoxType

MessageBoxStep.MessageBoxType getMessageBoxType()
                                         throws java.rmi.RemoteException

Returns:

the type of this message box.

Throws:

java.rmi.RemoteException - remote communication problem

setMessageBoxType

void setMessageBoxType(MessageBoxStep.MessageBoxType type)
                throws java.rmi.RemoteException

Sets the type of this message box.

Parameters:

type - the message box type

Throws:

java.rmi.RemoteException - remote communication problem