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

Interface FormalRequirementStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, TptRemote

All Known Subinterfaces:

BetweenStep, DocumentationStep, FromOrUntilStep, FromStep, ShallStep, UntilStep, WhenStep, WhileStep

public interface FormalRequirementStep
extends IdentifiableRemote

A step is one entry in a @List of @FormalRequirementStep in Requirement it can be created via addFormalRequirmentsStep(String type).

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDocumentation()
int	getHierarchyLevel()
java.lang.String	getType()
boolean	isActive()	Determines if this step is enabled.
void	setActive(boolean value)	Sets if this step is enabled.
void	setDocumentation(java.lang.String documentation)	TPT offers the possibility to assign some objects comments which are added to the report.
void	setHierarchyLevel(int level)	Sets the hierarchy level (indent) of the FormalRequiermentStep.

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

getIdentifier

Method Detail

getType

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

Returns:

the name of the step type.

Throws:

java.rmi.RemoteException - remote communication problem

setDocumentation

void setDocumentation(java.lang.String documentation)
               throws java.rmi.RemoteException,
                      ApiException

TPT offers the possibility to assign some objects comments which are added to the report. This method provides the possibility to define such a String.

Parameters:

documentation - a String which will be added as a comment to the report.

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if the documentation is null

getDocumentation

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

Returns:

a String which will be added as a comment to the report.

Throws:

java.rmi.RemoteException - remote communication problem

setActive

void setActive(boolean value)
        throws java.rmi.RemoteException

Sets if this step is enabled.

Parameters:

value - true if this step is active/enabled

Throws:

java.rmi.RemoteException - remote communication problem

isActive

boolean isActive()
          throws java.rmi.RemoteException

Determines if this step is enabled.

Returns:

true if this step is active/enabled

Throws:

java.rmi.RemoteException - remote communication problem

getHierarchyLevel

int getHierarchyLevel()
               throws java.rmi.RemoteException

Returns:

the hierarchy level (indent) of the FormalRequiermentStep. The hierarchy level starts from 0 and counts upwards. The indentation concatenates the indented step with the parent step using boolean AND. Formal requirement steps at the same indentation level are concatenated using boolean OR

Throws:

java.rmi.RemoteException - remote communication problem

setHierarchyLevel

void setHierarchyLevel(int level)
                throws java.rmi.RemoteException

Sets the hierarchy level (indent) of the FormalRequiermentStep. The hierarchy level starts from 0 and counts upwards. The indentation concatenates the indented step with the parent step using boolean AND. Formal requirement steps at the same indentation level are concatenated using boolean OR

Parameters:

level - the hierarchy level.

Throws:

java.rmi.RemoteException - remote communication problem