Class TestStepFields


  • public class TestStepFields
    extends java.lang.Object
    This class contains information that a TestStep may need to execute actions and create reports. Each TestStep has an instance of this class
    Since:
    1.0.0
    • Constructor Summary

      Constructors 
      Constructor Description
      TestStepFields()
      Instantiates a new TestStepFields
      TestStepFields​(boolean executeStep, java.util.Map<java.lang.String,​java.lang.String> dataSetRow, java.util.Map<java.lang.Integer,​java.lang.String> columnIndexMap, FunctionalTestStep parentFunctionalStep, java.lang.String testSetName, java.lang.String testScriptName, int testScriptNumber)
      Instantiates this class using the provided parameters.
    • Method Summary

      Modifier and Type Method Description
      java.util.Map<java.lang.Integer,​java.lang.String> getColumnIndexMap()
      Gets column index map.
      java.util.Map<java.lang.String,​java.lang.String> getDataSetRow()
      Gets data set row.
      java.lang.String getEnvironment()
      Gets environment.
      FunctionalTestStep getParentFunctionalStep()
      Gets parent functional step.
      java.lang.String getTestScriptName()
      Gets test script name.
      int getTestScriptNumber()
      Gets test script number.
      java.lang.String getTestSetName()
      Gets test set name.
      boolean isExecuteStep()
      Should the TestStep be executed
      void setColumnIndexMap​(java.util.Map<java.lang.Integer,​java.lang.String> columnIndexMap)
      Sets the columnIndexMap to be used with resolving a TestStep
      void setDataSetRow​(java.util.Map<java.lang.String,​java.lang.String> dataSetRow)
      Sets the dataSetRows to be used with resolving a TestStep
      void setEnvironment​(java.lang.String environment)
      Sets environment.
      void setExecuteStep​(boolean executeStep)
      Sets execute step.
      void setParentFunctionalStep​(FunctionalTestStep parentFunctionalStep)
      Sets parent functional step.
      void setTestScriptName​(java.lang.String testScriptName)
      Sets test script name.
      void setTestScriptNumber​(int testScriptNumber)
      Sets test script number.
      void setTestSetName​(java.lang.String testSetName)
      Sets test set name.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TestStepFields

        public TestStepFields()
        Instantiates a new TestStepFields
        Since:
        1.0.0
      • TestStepFields

        public TestStepFields​(boolean executeStep,
                              java.util.Map<java.lang.String,​java.lang.String> dataSetRow,
                              java.util.Map<java.lang.Integer,​java.lang.String> columnIndexMap,
                              FunctionalTestStep parentFunctionalStep,
                              java.lang.String testSetName,
                              java.lang.String testScriptName,
                              int testScriptNumber)
        Instantiates this class using the provided parameters.
        Parameters:
        executeStep - Whether or not the TestStep this TestStepFields belongs to should execute
        dataSetRow - the data set row
        columnIndexMap - the column index map
        parentFunctionalStep - The FunctionalTestStep the TestStep belongs to
        testSetName - The name of the testSet the TestStep belongs to
        testScriptName - The name of the TestScript the TestStep belongs to
        testScriptNumber - The testScriptNumber of the TestScript the TestStep belongs to
        Since:
        1.0.0
    • Method Detail

      • getEnvironment

        public java.lang.String getEnvironment()
        Gets environment. The environment the TestStep is running in
        Returns:
        the environment
        Since:
        1.0.0
      • setEnvironment

        public void setEnvironment​(java.lang.String environment)
        Sets environment.
        Parameters:
        environment - the environment the TestStep would run in
        Since:
        1.0.0
      • isExecuteStep

        public boolean isExecuteStep()
        Should the TestStep be executed
        Returns:
        true if the TestStep should be executed
        Since:
        1.0.0
      • setExecuteStep

        public void setExecuteStep​(boolean executeStep)
        Sets execute step.
        Parameters:
        executeStep - true if the TestStep should be executed
        Since:
        1.0.0
      • getDataSetRow

        public java.util.Map<java.lang.String,​java.lang.String> getDataSetRow()
        Gets data set row.
        Returns:
        the data set row // FIXME: 2/28/22
      • setDataSetRow

        public void setDataSetRow​(java.util.Map<java.lang.String,​java.lang.String> dataSetRow)
        Sets the dataSetRows to be used with resolving a TestStep
        Parameters:
        dataSetRow - A map containing column names (keys) and values for a dataset row // FIXME: 2/28/22
      • getColumnIndexMap

        public java.util.Map<java.lang.Integer,​java.lang.String> getColumnIndexMap()
        Gets column index map.
        Returns:
        the column index map // FIXME: 2/28/22
      • setColumnIndexMap

        public void setColumnIndexMap​(java.util.Map<java.lang.Integer,​java.lang.String> columnIndexMap)
        Sets the columnIndexMap to be used with resolving a TestStep
        Parameters:
        columnIndexMap - A map containing column indices (keys) and the column names (values) // FIXME: 2/28/22
      • setParentFunctionalStep

        public void setParentFunctionalStep​(FunctionalTestStep parentFunctionalStep)
        Sets parent functional step.
        Parameters:
        parentFunctionalStep - The FunctionalTestStep the TestStep belongs to
        Since:
        1.0.0
      • getTestSetName

        public java.lang.String getTestSetName()
        Gets test set name.
        Returns:
        the test set name
        Since:
        1.0.0
      • setTestSetName

        public void setTestSetName​(java.lang.String testSetName)
        Sets test set name.
        Parameters:
        testSetName - the test set name
        Since:
        1.0.0
      • getTestScriptName

        public java.lang.String getTestScriptName()
        Gets test script name.
        Returns:
        the test script name
        Since:
        1.0.0
      • setTestScriptName

        public void setTestScriptName​(java.lang.String testScriptName)
        Sets test script name.
        Parameters:
        testScriptName - the test script name
        Since:
        1.0.0
      • getTestScriptNumber

        public int getTestScriptNumber()
        Gets test script number.
        Returns:
        the test script number
        Since:
        1.0.0
      • setTestScriptNumber

        public void setTestScriptNumber​(int testScriptNumber)
        Sets test script number.
        Parameters:
        testScriptNumber - the test script number
        Since:
        1.0.0