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

Interface ShallStep

All Superinterfaces:

FormalRequirementStep, IdentifiableRemote, java.rmi.Remote, TptRemote

public interface ShallStep
extends FormalRequirementStep

This FormalRequirementStep specifies the expected behavior of a signal. The step should be indented after a restriction type step or event type step. The behavior of the Shall step differs depending on the step type is it indented after.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ShallStep.DurationType	The possible duration types.
static class	ShallStep.ToleranceType	The possible tolerance types.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDurationTime()
ShallStep.DurationType	getDurationType()	The duration type for the expression.
java.lang.String	getExpression()	The expression which will be checked.
java.lang.String	getMaxTime()	The max time of the expression.
java.lang.String	getToleranceTime()	The time tolerance for the expression.
ShallStep.ToleranceType	getToleranceType()	The time tolerance type for the expression.
void	setDurationTime(java.lang.String duration)	Sets the duration time for the expression.
void	setDurationType(ShallStep.DurationType durationType)	Sets the duration type for the expression.
void	setExpression(java.lang.String expr)	Sets the expression which will be checked.
void	setMaxTime(java.lang.String maxTime)	Sets the max time for the expression.
void	setToleranceTime(java.lang.String tolerance)	Sets the time tolerance for the expression.
void	setToleranceType(ShallStep.ToleranceType toleranceType)	Sets the time tolerance type for 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

setExpression

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

Sets the expression which will be checked.

Parameters:

expr - the expression

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the expr is null

getExpression

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

The expression which will be checked.

Returns:

the expression which will be checked.

Throws:

java.rmi.RemoteException - remote communication problem

setDurationType

void setDurationType(ShallStep.DurationType durationType)
              throws java.rmi.RemoteException,
                     ApiException

Sets the duration type for the expression.

Parameters:

durationType - type of the duration

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the durationType is null

getDurationType

ShallStep.DurationType getDurationType()
                                throws java.rmi.RemoteException

The duration type for the expression.

Returns:

the duration type for the expression.

Throws:

java.rmi.RemoteException - remote communication problem

setDurationTime

void setDurationTime(java.lang.String duration)
              throws java.rmi.RemoteException,
                     ApiException

Sets the duration time for the expression.

Parameters:

duration - the duration time

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the duration is null

getDurationTime

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

Returns:

the duration time for the expression.

Throws:

java.rmi.RemoteException - remote communication problem

setMaxTime

void setMaxTime(java.lang.String maxTime)
         throws java.rmi.RemoteException,
                ApiException

Sets the max time for the expression.

Parameters:

maxTime - the max time of the expression

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the maxTime is null

getMaxTime

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

The max time of the expression.

Returns:

the max time of the expression.

Throws:

java.rmi.RemoteException - remote communication problem

setToleranceType

void setToleranceType(ShallStep.ToleranceType toleranceType)
               throws java.rmi.RemoteException,
                      ApiException

Sets the time tolerance type for the expression.

Parameters:

toleranceType - type of the time tolerance

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the toleranceType is null

getToleranceType

ShallStep.ToleranceType getToleranceType()
                                  throws java.rmi.RemoteException

The time tolerance type for the expression.

Returns:

the time tolerance type for the expression.

Throws:

java.rmi.RemoteException - remote communication problem

setToleranceTime

void setToleranceTime(java.lang.String tolerance)
               throws java.rmi.RemoteException,
                      ApiException

Sets the time tolerance for the expression.

Parameters:

tolerance - the time tolerance

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the tolerance is null

getToleranceTime

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

The time tolerance for the expression.

Returns:

the time tolerance for the expression.

Throws:

java.rmi.RemoteException - remote communication problem