com.codepine.api.testrail

Class TestRail.Sections

java.lang.Object

com.codepine.api.testrail.TestRail.Sections

Enclosing class:

TestRail

public class TestRail.Sections
extends Object

Request factories for "Sections".

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Sections()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Sections

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

Method Detail

get

public TestRail.Sections.Get get(int sectionId)

Returns an existing section.

Parameters:

sectionId - the ID of the section

Returns:

the request

Throws:

IllegalArgumentException - if sectionId is not positive

list

public TestRail.Sections.List list(int projectId)

Returns a list of sections for a project.

Parameters:

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

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

list

public TestRail.Sections.List list(int projectId,
                                   int suiteId)

Returns a list of sections for a project and test suite.

Parameters:

projectId - the ID of the project

suiteId - the ID of the suite

Returns:

the request

Throws:

IllegalArgumentException - if any argument is not positive

add

public TestRail.Sections.Add add(int projectId,
                                 @NonNull
                                 Section section)

Creates a new section.

Parameters:

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

section - the section to be added

Returns:

the request

Throws:

NullPointerException - if section is null

update

public TestRail.Sections.Update update(@NonNull
                                       Section section)

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

Parameters:

section - the section to be updated

Returns:

the request

Throws:

NullPointerException - if section is null

delete

public TestRail.Sections.Delete delete(int sectionId)

Deletes an existing section.

Parameters:

sectionId - the ID of the section to be deleted

Returns:

the request

Throws:

IllegalArgumentException - if sectionId is not positive