com.codepine.api.testrail

Class TestRail.Suites

java.lang.Object

com.codepine.api.testrail.TestRail.Suites

Enclosing class:

TestRail

public class TestRail.Suites
extends Object

Request factories for "Suites".

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Suites()

Method Summary

Modifier and Type	Method and Description
TestRail.Suites.Add	add(int projectId, Suite suite) Creates a new test suite.
TestRail.Suites.Delete	delete(int suiteId) Deletes an existing test suite.
TestRail.Suites.Get	get(int suiteId) Returns an existing test suite.
TestRail.Suites.List	list(int projectId) Returns a list of test suites for a project.
TestRail.Suites.Update	update(Suite suite) Updates an existing test suite.

Methods inherited from class java.lang.Object

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

Constructor Detail

Suites

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

Method Detail

get

public TestRail.Suites.Get get(int suiteId)

Returns an existing test suite.

Parameters:

suiteId - the ID of the test suite

Returns:

the request

Throws:

IllegalArgumentException - if suiteId is not positive

list

public TestRail.Suites.List list(int projectId)

Returns a list of test suites for a project.

Parameters:

projectId - the ID of the project to get the test suites for

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

add

public TestRail.Suites.Add add(int projectId,
                               @NonNull
                               Suite suite)

Creates a new test suite.

Parameters:

projectId - the ID of the project to add the test suite to

suite - the test suite to be added

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

NullPointerException - if suite is null

update

public TestRail.Suites.Update update(@NonNull
                                     Suite suite)

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

Parameters:

suite - the test suite to be updated

Returns:

the request

Throws:

NullPointerException - if suite is null

delete

public TestRail.Suites.Delete delete(int suiteId)

Deletes an existing test suite.

Parameters:

suiteId - the ID of the test suite to be deleted

Returns:

the request

Throws:

IllegalArgumentException - if suiteId is not positive