Package com.piketec.tpt.api.steplist.formalrequirements

Interface WhileStep

All Superinterfaces:

FormalRequirementStep, IdentifiableRemote, java.rmi.Remote, TptRemote

public interface WhileStep
extends FormalRequirementStep

This FormalRequirementStep yields intervals for which the expression is true

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WhileStep.WhileType	The possible when types.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getExpression()
java.lang.String	getTime()
WhileStep.WhileType	getWhileType()
void	setExpression(java.lang.String expr)	Sets the expression.
void	setTime(java.lang.String time)	Sets the time for which the expression has to be true.
void	setWhileType(WhileStep.WhileType whileType)	Sets the type of evaluation of the expression.

Methods inherited from interface com.piketec.tpt.api.steplist.formalrequirements.FormalRequirementStep

getDocumentation, getHierarchyLevel, getType, isActive, setActive, setDocumentation, setHierarchyLevel

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

getIdentifier

Method Detail

getExpression

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

Returns:

the expression.

Throws:

java.rmi.RemoteException - remote communication problem

setExpression

void setExpression(java.lang.String expr)
            throws java.rmi.RemoteException,
                   ApiException

Sets the expression.

Parameters:

expr - the expression

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the expr is null

getWhileType

WhileStep.WhileType getWhileType()
                          throws java.rmi.RemoteException

Returns:

The type of evaluation of the expression.

Throws:

java.rmi.RemoteException - remote communication problem

setWhileType

void setWhileType(WhileStep.WhileType whileType)
           throws java.rmi.RemoteException,
                  ApiException

Sets the type of evaluation of the expression.

Parameters:

whileType - the type of the expression

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the whileType is null

getTime

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

Returns:

The time for which the expression has to be true.

Throws:

java.rmi.RemoteException - remote communication problem

setTime

void setTime(java.lang.String time)
      throws java.rmi.RemoteException,
             ApiException

Sets the time for which the expression has to be true.

Parameters:

time - the time

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the time is null