com.codepine.api.testrail

Class TestRail.Cases

java.lang.Object

com.codepine.api.testrail.TestRail.Cases

Enclosing class:

TestRail

public class TestRail.Cases
extends Object

Request factories for "Cases".

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
TestRail.Cases.Add	add(int sectionId, Case testCase, List<CaseField> caseFields) Creates a new test case.
TestRail.Cases.Delete	delete(int testCaseId) Deletes an existing test case.
TestRail.Cases.Get	get(int testCaseId, List<CaseField> caseFields) Returns an existing test case.
TestRail.Cases.List	list(int projectId, int suiteId, List<CaseField> caseFields) Returns the list of available test cases.
TestRail.Cases.List	list(int projectId, List<CaseField> caseFields) Returns the list of available test cases.
TestRail.Cases.Update	update(Case testCase, List<CaseField> caseFields) Updates an existing test case.

Methods inherited from class java.lang.Object

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

Method Detail

get

public TestRail.Cases.Get get(int testCaseId,
                     @NonNull
                     List<CaseField> caseFields)

Returns an existing test case.

The custom case fields configured in TestRail can be fetched using TestRail.CaseFields.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:

testCaseId - the ID of the test case

caseFields - the custom case fields configured in TestRail to get type information for custom fields in the test case returned

Returns:

the request

Throws:

IllegalArgumentException - if testCaseId is not positive

NullPointerException - if caseFields is null

list

public TestRail.Cases.List list(int projectId,
                       @NonNull
                       List<CaseField> caseFields)

Returns the list of available test cases.

The custom case fields configured in TestRail can be fetched using TestRail.CaseFields.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:

projectId - the ID of the project which is operating in a single suite mode

caseFields - the custom case fields configured in TestRail to get type information for custom fields in the test cases returned

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

NullPointerException - if caseFields is null

list

public TestRail.Cases.List list(int projectId,
                       int suiteId,
                       @NonNull
                       List<CaseField> caseFields)

Returns the list of available test cases.

The custom case fields configured in TestRail can be fetched using TestRail.CaseFields.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:

projectId - the ID of the project

suiteId - the ID of the suite

caseFields - the custom case fields configured in TestRail to get type information for custom fields in the test cases returned

Returns:

the request

Throws:

IllegalArgumentException - if any argument is not positive

NullPointerException - if caseFields is null

add

public TestRail.Cases.Add add(int sectionId,
                     @NonNull
                     Case testCase,
                     @NonNull
                     List<CaseField> caseFields)

Creates a new test case.

The custom case fields configured in TestRail can be fetched using TestRail.CaseFields.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:

sectionId - the ID of the section to add the test case to

testCase - the test case to be added

caseFields - the custom case fields configured in TestRail to get type information for custom fields in the test case returned

Returns:

the request

Throws:

IllegalArgumentException - if sectionId is not positive

NullPointerException - if any other argument is null

update

public TestRail.Cases.Update update(@NonNull
                           Case testCase,
                           @NonNull
                           List<CaseField> caseFields)

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

The custom case fields configured in TestRail can be fetched using TestRail.CaseFields.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:

testCase - the test case to be updated

caseFields - the custom case fields configured in TestRail to get type information for custom fields in the test case returned

Returns:

the request

Throws:

NullPointerException - if any argument is null

delete

public TestRail.Cases.Delete delete(int testCaseId)

Deletes an existing test case.

Parameters:

testCaseId - the ID of the test case to be deleted

Returns:

the request

Throws:

IllegalArgumentException - if testCaseId is not positive