com.codepine.api.testrail

Class TestRail.Projects

java.lang.Object

com.codepine.api.testrail.TestRail.Projects

Enclosing class:

TestRail

public class TestRail.Projects
extends Object

Request factories for "Projects".

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
TestRail.Projects.Add	add(Project project) Creates a new project.
TestRail.Projects.Delete	delete(int projectId) Deletes an existing project.
TestRail.Projects.Get	get(int projectId) Returns an existing project.
TestRail.Projects.List	list() Returns the list of available projects.
TestRail.Projects.Update	update(Project project) Updates an existing project.

Methods inherited from class java.lang.Object

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

Method Detail

get

public TestRail.Projects.Get get(int projectId)

Returns an existing project.

Parameters:

projectId - the ID of the project

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

list

public TestRail.Projects.List list()

Returns the list of available projects.

Returns:

the request

add

public TestRail.Projects.Add add(@NonNull
                                 Project project)

Creates a new project.

Parameters:

project - the project to be added

Returns:

the request

Throws:

NullPointerException - if project is null

update

public TestRail.Projects.Update update(@NonNull
                                       Project project)

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

Parameters:

project - the project to be updated

Returns:

the request

Throws:

NullPointerException - if project is null

delete

public TestRail.Projects.Delete delete(int projectId)

Deletes an existing project.

Parameters:

projectId - the ID of the project to be deleted

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive