Package com.qcefast.fastXml

Class TestScript

  • public class TestScript
extends java.lang.Object
    Used to represent a testscript within a FastXml driver
    Since:
    1.0.0

    • Constructor Detail

      • TestScript

        public TestScript()

    • Method Detail

      • 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

      • getTestScriptId

        public java.lang.String getTestScriptId()
        Gets test script id.
        Returns:
        the test script id
        Since:
        1.0.0

      • setTestScriptId

        public void setTestScriptId​(java.lang.String testScriptId)
        Sets test script id.
        Parameters:
        testScriptId - the test script id
        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

      • 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

      • getDescription

        public java.lang.String getDescription()
        Gets description.
        Returns:
        the description
        Since:
        1.0.0

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets description.
        Parameters:
        description - the description
        Since:
        1.0.0

      • getStatus

        public Status getStatus()
        Gets status.
        Returns:
        The Status for this TestScript before or after execution
        Since:
        1.0.0

      • setStatus

        public void setStatus​(Status status)
        Sets status.
        Parameters:
        status - The Status of this TestScript
        Since:
        1.0.0

      • getMessage

        public java.lang.String getMessage()
        Gets message.
        Returns:
        A message that may contain information about the execution for this TestScript
        Since:
        1.0.0

      • setMessage

        public void setMessage​(java.lang.String message)
        Sets message.
        Parameters:
        message - A message that may contain information about the execution for this FastXml
        Since:
        1.0.0

      • setFramework

        public void setFramework​(Framework framework)
        Sets framework.
        Parameters:
        framework - The Framework being used with this TestScript
        Since:
        1.0.0

      • setFunctionalTestSteps

        public void setFunctionalTestSteps​(java.util.List<FunctionalTestStep> functionalTestSteps)
        Sets functional test steps.
        Parameters:
        functionalTestSteps - A List for TestStep that is to belong to this FunctionalTestStep
        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

      • getStartTime

        public java.util.Date getStartTime()
        Gets start time.
        Returns:
        The Date this TestScript 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 TestScript stopped executing
        Since:
        1.0.0

      • setEndTime

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

      • getTags

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

      • setTags

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

      • execute

        public void execute()
             throws FastException
        Executes all the functional steps in this test script.

        Failed TestSteps with FailType:

        • FAIL_FSTEP will skip the remainder of the current FunctionalTestStep and continue onto the next FunctionalTestStep in this 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
        Since:
        1.0.0