com.codepine.api.testrail

Class TestRail.Plans

java.lang.Object

com.codepine.api.testrail.TestRail.Plans

Enclosing class:

TestRail

public class TestRail.Plans
extends Object

Request factories for "Plans".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TestRail.Plans.Add
class	TestRail.Plans.AddEntry
class	TestRail.Plans.Close
class	TestRail.Plans.Delete
class	TestRail.Plans.DeleteEntry
class	TestRail.Plans.Get
class	TestRail.Plans.List
class	TestRail.Plans.Update
class	TestRail.Plans.UpdateEntry

Constructor Summary

Constructors

Constructor and Description
Plans()

Method Summary

Modifier and Type	Method and Description
TestRail.Plans.Add	add(int projectId, Plan plan) Creates a new test plan.
TestRail.Plans.AddEntry	addEntry(int planId, Plan.Entry entry) Adds one or more new test runs to a test plan.
TestRail.Plans.Close	close(int planId) Closes an existing test plan and archives its test runs & results.
TestRail.Plans.Delete	delete(int planId) Deletes an existing test plan.
TestRail.Plans.DeleteEntry	deleteEntry(int planId, int entryId) Deletes one or more existing test runs from a plan.
TestRail.Plans.Get	get(int planId) Returns an existing test plan.
TestRail.Plans.List	list(int projectId) Returns a list of test plans for a project.
TestRail.Plans.Update	update(Plan plan) Updates an existing test plan.
TestRail.Plans.UpdateEntry	updateEntry(int planId, Plan.Entry entry) Updates one or more existing test runs in a plan.

Methods inherited from class java.lang.Object

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

Constructor Detail

Plans

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

Method Detail

get

public TestRail.Plans.Get get(int planId)

Returns an existing test plan.

Parameters:

planId - the ID of the test plan

Returns:

the request

Throws:

IllegalArgumentException - if planId is not positive

list

public TestRail.Plans.List list(int projectId)

Returns a list of test plans for a project.

Parameters:

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

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

add

public TestRail.Plans.Add add(int projectId,
                              @NonNull
                              Plan plan)

Creates a new test plan.

Parameters:

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

plan - the test plan to be added

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

NullPointerException - if plan is null

update

public TestRail.Plans.Update update(@NonNull
                                    Plan plan)

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

Parameters:

plan - the test plan to be updated

Returns:

the request

Throws:

NullPointerException - if plan is null

close

public TestRail.Plans.Close close(int planId)

Closes an existing test plan and archives its test runs & results.

Parameters:

planId - the ID of the test plan to be closed

Returns:

the request

Throws:

IllegalArgumentException - if planId is not positive

delete

public TestRail.Plans.Delete delete(int planId)

Deletes an existing test plan.

Parameters:

planId - the ID of the test plan to be deleted

Returns:

the request

Throws:

IllegalArgumentException - if planId is not positive

addEntry

public TestRail.Plans.AddEntry addEntry(int planId,
                                        @NonNull
                                        Plan.Entry entry)

Adds one or more new test runs to a test plan.

Parameters:

planId - the ID of the test plan to add the entry to

entry - the plan entry to be added

Returns:

the request

Throws:

IllegalArgumentException - if planId is not positive

NullPointerException - if any argument is null

updateEntry

public TestRail.Plans.UpdateEntry updateEntry(int planId,
                                              @NonNull
                                              Plan.Entry entry)

Updates one or more existing test runs in a plan. Partial updates are supported, i.e. you can set and update specific fields only.

Parameters:

planId - the ID of the test plan to update the entry in

entry - the plan entry to be updated

Returns:

the request

Throws:

IllegalArgumentException - if planId is not positive

NullPointerException - if any argument is null

deleteEntry

public TestRail.Plans.DeleteEntry deleteEntry(int planId,
                                              int entryId)

Deletes one or more existing test runs from a plan.

Parameters:

planId - the ID of the test plan to delete entry from

entryId - the ID of the plan entry to be deleted

Returns:

the request

Throws:

IllegalArgumentException - if any argument is not positive