com.codepine.api.testrail

Class TestRail.Runs

java.lang.Object

com.codepine.api.testrail.TestRail.Runs

Enclosing class:

TestRail

public class TestRail.Runs
extends Object

Request factories for "Runs".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TestRail.Runs.Add
class	TestRail.Runs.Close
class	TestRail.Runs.Delete
class	TestRail.Runs.Get
class	TestRail.Runs.List
class	TestRail.Runs.Update

Constructor Summary

Constructors

Constructor and Description
TestRail.Runs()

Method Summary

Methods

Modifier and Type	Method and Description
TestRail.Runs.Add	add(int projectId, Run run) Creates a new test run.
TestRail.Runs.Close	close(int runId) Closes an existing test run and archives its tests & results.
TestRail.Runs.Delete	delete(int runId) Deletes an existing test run.
TestRail.Runs.Get	get(int runId) Returns an existing test run.
TestRail.Runs.List	list(int projectId) Returns a list of test runs for a project.
TestRail.Runs.Update	update(Run run) Updates an existing test run.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestRail.Runs

@Generated(value="lombok")
public TestRail.Runs()

Method Detail

get

public TestRail.Runs.Get get(int runId)

Returns an existing test run.

Parameters:

runId - the ID of the test run

Returns:

the request

Throws:

IllegalArgumentException - if runId is not positive

list

public TestRail.Runs.List list(int projectId)

Returns a list of test runs for a project. Only returns those test runs that are not part of a test plan.

Parameters:

projectId - the ID of the project to get the runs for

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

add

public TestRail.Runs.Add add(int projectId,
                    @NonNull
                    Run run)

Creates a new test run.

Parameters:

projectId - the ID of the project to add the run to

run - the test run to be added

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

NullPointerException - if run is null

update

public TestRail.Runs.Update update(@NonNull
                          Run run)

Updates an existing test run. Partial updates are supported, i.e. you can set and update specific fields only.

Parameters:

run - the test run to be updated

Returns:

the request

Throws:

NullPointerException - if run is null

close

public TestRail.Runs.Close close(int runId)

Closes an existing test run and archives its tests & results.

Parameters:

runId - the ID of the test run to be closed

Returns:

the request

Throws:

IllegalArgumentException - if runId is not positive

delete

public TestRail.Runs.Delete delete(int runId)

Deletes an existing test run.

Parameters:

runId - the ID of the test run to be deleted

Returns:

the request

Throws:

IllegalArgumentException - if runId is not positive