com.codepine.api.testrail

Class TestRail.Results

java.lang.Object

com.codepine.api.testrail.TestRail.Results

Enclosing class:

TestRail

public class TestRail.Results
extends Object

Request factories for "Results".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TestRail.Results.Add
class	TestRail.Results.AddForCase
class	TestRail.Results.AddList
class	TestRail.Results.AddListForCases
class	TestRail.Results.List
class	TestRail.Results.ListForCase
class	TestRail.Results.ListForRun

Constructor Summary

Constructors

Constructor and Description
Results()

Method Summary

Modifier and Type	Method and Description
TestRail.Results.AddList	add(int runId, List<Result> results, List<ResultField> resultFields) Adds one or more new test results, comments or assigns one or more tests.
TestRail.Results.Add	add(int testId, Result result, List<ResultField> resultFields) Adds a new test result, comment or assigns a test.
TestRail.Results.AddForCase	addForCase(int runId, int testCaseId, Result result, List<ResultField> resultFields) Adds a new test result, comment or assigns a test (for a test run and case combination).
TestRail.Results.AddListForCases	addForCases(int runId, List<Result> results, List<ResultField> resultFields) Adds one or more new test results, comments or assigns one or more tests (using the case IDs).
TestRail.Results.List	list(int testId, List<ResultField> resultFields) Returns a list of test results for a test.
TestRail.Results.ListForCase	listForCase(int runId, int testCaseId, List<ResultField> resultFields) Returns a list of test results for a test run and case combination.
TestRail.Results.ListForRun	listForRun(int runId, List<ResultField> resultFields) Returns a list of test results for a test run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Results

@Generated(value="lombok")
public Results()

Method Detail

list

public TestRail.Results.List list(int testId,
                                  @NonNull
                                  List<ResultField> resultFields)

Returns a list of test results for a test.

The custom result fields configured in TestRail can be fetched using TestRail.ResultFields.list() request. The reason for not fetching this during execution of this request is to allow you to cache the list on your end to prevent an extra call on every execution.

Parameters:

testId - the ID of the test to get the results for

resultFields - the custom result fields configured in TestRail to get type information for custom fields in the results returned

Returns:

the request

Throws:

IllegalArgumentException - if testId is not positive

NullPointerException - if resultFields is null

listForCase

public TestRail.Results.ListForCase listForCase(int runId,
                                                int testCaseId,
                                                @NonNull
                                                List<ResultField> resultFields)

Returns a list of test results for a test run and case combination.

The custom result fields configured in TestRail can be fetched using TestRail.ResultFields.list() request. The reason for not fetching this during execution of this request is to allow you to cache the list on your end to prevent an extra call on every execution.

Parameters:

runId - the ID of the test run

testCaseId - the ID of the test case

resultFields - the custom result fields configured in TestRail to get type information for custom fields in the results returned

Returns:

the request

Throws:

IllegalArgumentException - if any argument is not positive

NullPointerException - if resultFields is null

listForRun

public TestRail.Results.ListForRun listForRun(int runId,
                                              @NonNull
                                              List<ResultField> resultFields)

Returns a list of test results for a test run.

The custom result fields configured in TestRail can be fetched using TestRail.ResultFields.list() request. The reason for not fetching this during execution of this request is to allow you to cache the list on your end to prevent an extra call on every execution.

Parameters:

runId - the ID of the test run to get the results for

resultFields - the custom result fields configured in TestRail to get type information for custom fields in the results returned

Returns:

the request

Throws:

IllegalArgumentException - if runId is not positive

NullPointerException - if resultFields is null

add

public TestRail.Results.Add add(int testId,
                                @NonNull
                                Result result,
                                @NonNull
                                List<ResultField> resultFields)

Adds a new test result, comment or assigns a test.

The custom result fields configured in TestRail can be fetched using TestRail.ResultFields.list() request. The reason for not fetching this during execution of this request is to allow you to cache the list on your end to prevent an extra call on every execution.

Parameters:

testId - the ID of the test whose result is to be added

result - the test result to be added

resultFields - the custom result fields configured in TestRail to get type information for custom fields in the result returned

Returns:

the request

Throws:

IllegalArgumentException - if testId is not positive

NullPointerException - if any other argument is null

addForCase

public TestRail.Results.AddForCase addForCase(int runId,
                                              int testCaseId,
                                              @NonNull
                                              Result result,
                                              @NonNull
                                              List<ResultField> resultFields)

Adds a new test result, comment or assigns a test (for a test run and case combination).

The custom result fields configured in TestRail can be fetched using TestRail.ResultFields.list() request. The reason for not fetching this during execution of this request is to allow you to cache the list on your end to prevent an extra call on every execution.

Parameters:

runId - the ID of the test run

testCaseId - the ID of the test case

result - the test result to be added

resultFields - the custom result fields configured in TestRail to get type information for custom fields in the result returned

Returns:

the request

Throws:

IllegalArgumentException - if runId or testCaseId is not positive

NullPointerException - if any other argument is null

add

public TestRail.Results.AddList add(int runId,
                                    @NonNull
                                    List<Result> results,
                                    @NonNull
                                    List<ResultField> resultFields)

Adds one or more new test results, comments or assigns one or more tests.

The custom result fields configured in TestRail can be fetched using TestRail.ResultFields.list() request. The reason for not fetching this during execution of this request is to allow you to cache the list on your end to prevent an extra call on every execution.

Parameters:

runId - the ID of the test run to add the results to

results - the test results to be added

resultFields - the custom result fields configured in TestRail to get type information for custom fields in the results returned

Returns:

the request

Throws:

IllegalArgumentException - if runId is not positive or results is empty

NullPointerException - if results or resultFields are null

addForCases

public TestRail.Results.AddListForCases addForCases(int runId,
                                                    @NonNull
                                                    List<Result> results,
                                                    @NonNull
                                                    List<ResultField> resultFields)

Adds one or more new test results, comments or assigns one or more tests (using the case IDs).

The custom result fields configured in TestRail can be fetched using TestRail.ResultFields.list() request. The reason for not fetching this during execution of this request is to allow you to cache the list on your end to prevent an extra call on every execution.

Parameters:

runId - the ID of the test run to add the results to

results - the test results to be added

resultFields - the custom result fields configured in TestRail to get type information for custom fields in the results returned

Returns:

the request

Throws:

IllegalArgumentException - if runId is not positive or results is empty

NullPointerException - if results or resultFields are null