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

Interface WhenStep

All Superinterfaces:

FormalRequirementStep, IdentifiableRemote, java.rmi.Remote, TptRemote

public interface WhenStep
extends FormalRequirementStep

This FormalRequirementStep defines an interval which happens when a condition is evaluated based on the WhenStep.WhenType.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WhenStep.WhenType	The possible when types.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getExpression()
java.lang.String	getTime()	The time component which belongs to the type of the evaluation.
WhenStep.WhenType	getWhenType()	The type of evaluation of the expression.
void	setExpression(java.lang.String expr)	Sets the expression.
void	setTime(java.lang.String time)	Sets the time component which belongs to the type of the evaluation
void	setWhenType(WhenStep.WhenType whenType)	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

getWhenType

WhenStep.WhenType getWhenType()
                       throws java.rmi.RemoteException

The type of evaluation of the expression.

Returns:

The type of evaluation of the expression.

Throws:

java.rmi.RemoteException - remote communication problem

setWhenType

void setWhenType(WhenStep.WhenType whenType)
          throws java.rmi.RemoteException,
                 ApiException

Sets the type of evaluation of the expression.

Parameters:

whenType - the type of the expression

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the whenType is null

getTime

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

The time component which belongs to the type of the evaluation.

Returns:

The time component which belongs to the type of the evaluation.

Throws:

java.rmi.RemoteException - remote communication problem

setTime

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

Sets the time component which belongs to the type of the evaluation

Parameters:

time - the time

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the time is null