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

Interface FromOrUntilStep

All Superinterfaces:

FormalRequirementStep, IdentifiableRemote, java.rmi.Remote, TptRemote

All Known Subinterfaces:

FromStep, UntilStep

public interface FromOrUntilStep
extends FormalRequirementStep

This FormalRequirementStep represents a the base step for the FromStep and UntilStep.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FromOrUntilStep.TriggerType	The possible trigger types.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getExpression()
java.lang.String	getTriggerLength()	The length for which the trigger expression must be true.
FromOrUntilStep.TriggerType	getTriggerType()	The trigger type used for the expression.
void	setTriggerLength(java.lang.String triggerLength)	Sets the trigger length for which the expression must be true.
void	setTriggerType(FromOrUntilStep.TriggerType triggerType)	Sets the trigger type used 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

getExpression

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

Returns:

the expression.

Throws:

java.rmi.RemoteException - remote communication problem

getTriggerType

FromOrUntilStep.TriggerType getTriggerType()
                                    throws java.rmi.RemoteException

The trigger type used for the expression.

Returns:

the trigger type used for the expression.

Throws:

java.rmi.RemoteException - remote communication problem

setTriggerType

void setTriggerType(FromOrUntilStep.TriggerType triggerType)
             throws java.rmi.RemoteException,
                    ApiException

Sets the trigger type used for the expression.

Parameters:

triggerType - type of the trigger

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the triggerType is null

setTriggerLength

void setTriggerLength(java.lang.String triggerLength)
               throws java.rmi.RemoteException,
                      ApiException

Sets the trigger length for which the expression must be true.

Parameters:

triggerLength - length for which the trigger must be present

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the triggerLength is null

getTriggerLength

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

The length for which the trigger expression must be true.

Returns:

the length for which the trigger expression must be true

Throws:

java.rmi.RemoteException - remote communication problem