Package com.qcefast.fastXml

Class FunctionalTestStep

  • public class FunctionalTestStep
extends java.lang.Object
    Represents a functional step within a TestScript
    Since:
    1.0.0

    • Method Detail

      • getFtsNumber

        public int getFtsNumber()
        Gets fts number.
        Returns:
        The step number for this FunctionalTestStep
        Since:
        1.0.0

      • setFtsNumber

        public void setFtsNumber​(int ftsNumber)
        Sets fts number.
        Parameters:
        ftsNumber - The step number for this FunctionalTestStep
        Since:
        1.0.0

      • getName

        public java.lang.String getName()
        Gets name.
        Returns:
        The name of this FunctionalTestStep
        Since:
        1.0.0

      • setName

        public void setName​(java.lang.String name)
        Sets name.
        Parameters:
        name - The name of this FunctionalTestStep
        Since:
        1.0.0

      • getDescription

        public java.lang.String getDescription()
        Gets description.
        Returns:
        The description of this FunctionalTestStep
        Since:
        1.0.0

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets description.
        Parameters:
        description - The description of this FunctionalTestStep
        Since:
        1.0.0

      • getParentFramework

        public Framework getParentFramework()
        Gets parent framework.
        Returns:
        The Framework belonging to the TestScript this FunctionalTestStep belongs to. Will be null if not being parsed from a FAST xml file.
        Since:
        1.0.0

      • setParentFramework

        public void setParentFramework​(Framework parentFramework)
        Sets parent framework.
        Parameters:
        parentFramework - The Framework that this FunctionalTestStep should use as its parent framework (the Framework of the TestScript this step belongs to).
        Since:
        1.0.0

      • setTestSteps

        public void setTestSteps​(java.util.List<TestStep> testSteps)
        Sets test steps.
        Parameters:
        testSteps - A List for TestStep that is to belong to this FunctionalTestStep
        Since:
        1.0.0

      • isExecuteDataSet

        public boolean isExecuteDataSet()
        Is execute data set boolean.
        Returns:
        the boolean

      • setExecuteDataSet

        public void setExecuteDataSet​(boolean executeDataSet)
        Sets execute data set.
        Parameters:
        executeDataSet - the execute data set

      • getDataSetFile

        public java.lang.String getDataSetFile()
        Gets data set file.
        Returns:
        the data set file

      • setDataSetFile

        public void setDataSetFile​(java.lang.String dataSetFile)
        Sets data set file.
        Parameters:
        dataSetFile - the data set file

      • getExecuteCount

        public int getExecuteCount()
        Gets execute count.
        Returns:
        the execute count

      • setExecuteCount

        public void setExecuteCount​(int executeCount)
        Sets execute count.
        Parameters:
        executeCount - the execute count

      • isDataSetCreated

        public boolean isDataSetCreated()
        Is data set created boolean.
        Returns:
        the boolean //TODO: Update this

      • setDataSetCreated

        public void setDataSetCreated​(boolean dataSetCreated)
        Sets data set created.
        Parameters:
        dataSetCreated - the data set created //TODO: Update this

      • getTags

        public java.util.Set<java.lang.String> getTags()
        Gets tags.
        Returns:
        The tags that can be used to determine whether or not this FunctionalTestStep should be executed
        Since:
        1.0.0

      • setTags

        public void setTags​(java.lang.String functionalStepTags)
        Sets tags.
        Parameters:
        functionalStepTags - The tags that can be used to determine whether or not this FunctionalTestStep should be executed
        Since:
        1.0.0

      • getBddStepName

        public java.lang.String getBddStepName()
        Gets bdd step name.
        Returns:
        the bdd step name
        Since:
        1.0.0

      • setBddStepName

        public void setBddStepName​(java.lang.String bddStepName)
        Sets bdd step name.
        Parameters:
        bddStepName - the bdd step name
        Since:
        1.0.0

      • getRunId

        public java.lang.String getRunId()
        Gets run id.
        Returns:
        the run id
        Since:
        1.0.0

      • setRunId

        public void setRunId​(java.lang.String runId)
        Sets run id.
        Parameters:
        runId - the run id
        Since:
        1.0.0

      • getTestScriptNumber

        public int getTestScriptNumber()
        Gets test script number.
        Returns:
        The test script number for the TestScript this FunctionalTestStep belongs to
        Since:
        1.0.0

      • setTestScriptNumber

        public void setTestScriptNumber​(int testScriptNumber)
        Sets test script number.
        Parameters:
        testScriptNumber - The test script number for the TestScript this FunctionalTestStep belongs to
        Since:
        1.0.0

      • getStartTime

        public java.util.Date getStartTime()
        Gets start time.
        Returns:
        The Date this FunctionalTestStep began executing
        Since:
        1.0.0

      • setStartTime

        public void setStartTime​(java.util.Date startTime)
        Sets start time.
        Parameters:
        startTime - The Date this FastXml begins executing
        Since:
        1.0.0

      • getEndTime

        public java.util.Date getEndTime()
        Gets end time.
        Returns:
        The Date this FunctionalTestStep stopped executing
        Since:
        1.0.0

      • setEndTime

        public void setEndTime​(java.util.Date endTime)
        Sets end time.
        Parameters:
        endTime - The Date this FunctionalTestStep stops executing
        Since:
        1.0.0

      • execute

        public void execute()
             throws FastException
        Executes all the teststeps in this FunctionalTestStep.

        Failed TestSteps with FailType:

        • FAIL_TSTEP will continue past the test step that is currently execute, and execute the next one if one is available
        • FAIL_FSTEP will skip the remainder of this FunctionalTestStep and continue onto the next FunctionalTestStep in a TestScript if one is available
        • FAIL_TCASE will skip the remainder of the current TestScript being ran
        • FAIL_TSUITE will throw a FastException with failType FAIL_TSUITE, and cease execution of all TestScripts in a FastXml
        Throws:
        FastException - If an error occurs during execution
        Since:
        1.0.0