Result (TAUtilities API)

All Superinterfaces:

Entity
```
public interface Result
extends Entity
```
This interface contains information of test module result.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`exportToHTML(String exportFolder)` Exports test result into the HTML format.
`String`	`getChecks()` Returns the total number of checks.
`String`	`getComment()` Returns the value of the the Comment field in the test result.
`String`	`getDateOfRun()` Returns the date of the running test.
`String`	`getDuration()` Returns the test duration.
`String`	`getEndTime()` Returns the time when the test run terminates.
`int`	`getErrors()` Returns the total number of error checks.
`int`	`getFailures()` Returns the total number of failed checks.
`int`	`getIgnoredFails()` Returns the number of failed checkpoints that are marked as known bugs.
`String`	`getLocation()` Returns the location of the test result.
`String`	`getNotes()` Returns the value of the Note field in the test result.
`int`	`getPassed()` Returns the total number of passing checks.
`String`	`getReporter()` Returns the value of the Reporter field in the test result.
`String`	`getResult()` Returns the final result of a test run.
`String`	`getResultName()` Returns the title of the test result.
`String`	`getRunMachine()` Returns the value of the Run Machine field in the test result.
`String`	`getStartTime()` Returns the starting time of the test run
`Collection`	`getTestCaseResults()` Returns a list of test case result.
`String`	`getTestFileName()` Returns the title of the executed test module.
`TestModule`	`getTestModule()` Returns the test module belonging to the current test result.
`int`	`getUnverifiedPictureChecks()` Return the total number of unverified picture checks (pictures not yet submitted).
`String`	`getVariation()` Returns the value of the Variation field in the test result.
`int`	`getWarnings()` Returns the total number of warning checks.
`String`	`getWebLink()` Gets the value of the Web Link field in the current test result.
`boolean`	`isAutomated()` Tests if the test run is automated.
`boolean`	`uploadResult(String treePath)` Determines whether a local result is automatically updated to the repository after the test run is complete.

Methods inherited from interface com.testarchitect.Entity
getFieldValue, getName

- Method Detail
  - getTestCaseResults
```
Collection getTestCaseResults()
```
    Returns a list of test case result.
    
    Returns:
    
    A collection of the TestCaseResult object.
  - exportToHTML
```
String exportToHTML(String exportFolder)
```
    Exports test result into the HTML format.
    
    Parameters:
    
    exportFolder - the folder destination of the export.
    
    Returns:
    
    Upon completion, return the method’s status. Possible returned values are:
    OK or location path if export successful
    FAIL or error messages if export unsuccessful
  - getDateOfRun
```
String getDateOfRun()
```
    Returns the date of the running test.
    
    Returns:
    
    A string value of the date of run.
  - getStartTime
```
String getStartTime()
```
    Returns the starting time of the test run
    
    Returns:
    
    A string value of the starting time.
  - getEndTime
```
String getEndTime()
```
    Returns the time when the test run terminates.
    
    Returns:
    
    A string value of the end time.
  - getDuration
```
String getDuration()
```
    Returns the test duration.
    
    Returns:
    
    A string value of the test duration.
  - getComment
```
String getComment()
```
    Returns the value of the the Comment field in the test result.
    
    Returns:
    
    A string contains the value of the Comment field.
  - getVariation
```
String getVariation()
```
    Returns the value of the Variation field in the test result.
    
    Returns:
    
    A string contains the value of the Variation field.
  - isAutomated
```
boolean isAutomated()
```
    Tests if the test run is automated.
    
    Returns:
    
    true if the Automation/Manual field in the test result is Automated; otherwise, false.
  - getReporter
```
String getReporter()
```
    Returns the value of the Reporter field in the test result.
    
    Returns:
    
    A string contains the value of the Reporter field.
  - getRunMachine
```
String getRunMachine()
```
    Returns the value of the Run Machine field in the test result.
    
    Returns:
    
    A string contains the value of the Run Machine field.
  - getLocation
```
String getLocation()
```
    Returns the location of the test result.
    
    Returns:
    
    A string value of the location of the test result.
  - getNotes
```
String getNotes()
```
    Returns the value of the Note field in the test result.
    
    Returns:
    
    A string value contains the value of the Notes field.
  - getResult
```
String getResult()
```
    Returns the final result of a test run.
    
    Returns:
    
    A string value of the result of the test run.
  - getResultName
```
String getResultName()
```
    Returns the title of the test result.
    
    Returns:
    
    A string value of the title of the test result.
  - getTestFileName
```
String getTestFileName()
```
    Returns the title of the executed test module.
    
    Returns:
    
    A string value of the title of the recently executed test module.
  - getChecks
```
String getChecks()
```
    Returns the total number of checks.
    
    Returns:
    
    A string value of the total number of checks.
  - getPassed
```
int getPassed()
```
    Returns the total number of passing checks.
    
    Returns:
    
    A string value of the total number of passing checks.
  - getFailures
```
int getFailures()
```
    Returns the total number of failed checks.
    
    Returns:
    
    A string value of the total number of failed checks.
  - getErrors
```
int getErrors()
```
    Returns the total number of error checks.
    
    Returns:
    
    A string value of the total number of error checks.
  - getWarnings
```
int getWarnings()
```
    Returns the total number of warning checks.
    
    Returns:
    
    A string value of the total number of warning checks.
  - getIgnoredFails
```
int getIgnoredFails()
```
    Returns the number of failed checkpoints that are marked as known bugs.
    
    Returns:
    
    A string value of the total number of ignored failed checkpoints.
  - uploadResult
```
boolean uploadResult(String treePath)
```
    Determines whether a local result is automatically updated to the repository after the test run is complete.
    
    Parameters:
    
    treePath - - the relative tree path representing the location where to store the uploaded local result into repository.
    
    Returns:
    
    Return true if successful; otherwise, false.
  - getWebLink
```
String getWebLink()
```
    Gets the value of the Web Link field in the current test result.
    
    Returns:
    
    A string value contains the value of the Web Link field.
  - getTestModule
```
TestModule getTestModule()
```
    Returns the test module belonging to the current test result.
    
    Returns:
    
    a TestModule object, or null
  - getUnverifiedPictureChecks
```
int getUnverifiedPictureChecks()
```
    Return the total number of unverified picture checks (pictures not yet submitted).
    
    Returns:
    
    A integer value of the total number of unverified picture checks (pictures not yet submitted).

Interface Result

Method Summary

Methods inherited from interface com.testarchitect.Entity

Method Detail

getTestCaseResults

exportToHTML

getDateOfRun

getStartTime

getEndTime

getDuration

getComment

getVariation

isAutomated

getReporter

getRunMachine

getLocation

getNotes

getResult

getResultName

getTestFileName

getChecks

getPassed

getFailures

getErrors

getWarnings

getIgnoredFails

uploadResult

getWebLink

getTestModule

getUnverifiedPictureChecks