org.touchbit.testrail4j.jackson2.model.TRSection

public class TRSection
extends Object

The depth, display_order and parent fields determine the hierarchy of the sections in a test suite. The depth field is 0 for all sections on the root level and greater than 0 for all child sections. The depth field therefore resembles the level in the section hierarchy. Also see get_sections for an example.

Constructor Summary

Constructors
Constructor	Description
`TRSection()`	No args constructor for use in serialization
`TRSection(String description, Long id, Long suiteId, Long parentId, String name, Long depth, Long displayOrder)`

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(Object other)`
`Map<String,Object>`	`getAdditionalProperties()`
`Long`	`getDepth()`	The level in the section hierarchy of the test suite
`String`	`getDescription()`	The description of the section (added with TestRail 4.0)
`Long`	`getDisplayOrder()`	The order in the test suite
`Long`	`getId()`	The ID of the section
`String`	`getName()`	The name of the section (required) (Required)
`Long`	`getParentId()`	The ID of the parent section (to build section hierarchies)
`Long`	`getSuiteId()`	The ID of the test suite (ignored if the project is operating in single suite mode, required otherwise)
`int`	`hashCode()`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setDepth(Long depth)`	The level in the section hierarchy of the test suite
`void`	`setDescription(String description)`	The description of the section (added with TestRail 4.0)
`void`	`setDisplayOrder(Long displayOrder)`	The order in the test suite
`void`	`setId(Long id)`	The ID of the section
`void`	`setName(String name)`	The name of the section (required) (Required)
`void`	`setParentId(Long parentId)`	The ID of the parent section (to build section hierarchies)
`void`	`setSuiteId(Long suiteId)`	The ID of the test suite (ignored if the project is operating in single suite mode, required otherwise)
`String`	`toString()`
`TRSection`	`withAdditionalProperty(String name, Object value)`
`TRSection`	`withDepth(Long depth)`
`TRSection`	`withDescription(String description)`
`TRSection`	`withDisplayOrder(Long displayOrder)`
`TRSection`	`withId(Long id)`
`TRSection`	`withName(String name)`
`TRSection`	`withParentId(Long parentId)`
`TRSection`	`withSuiteId(Long suiteId)`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- TRSection
  
  public TRSection()
  
  No args constructor for use in serialization
- TRSection
  
  public TRSection(String description, Long id, Long suiteId, Long parentId, String name, Long depth, Long displayOrder)
  
  Parameters:
  
  suiteId -
  
  depth -
  
  name -
  
  displayOrder -
  
  description -
  
  id -
  
  parentId -
Method Details
- getDescription
  
  public String getDescription()
  
  The description of the section (added with TestRail 4.0)
- setDescription
  
  public void setDescription(String description)
  
  The description of the section (added with TestRail 4.0)
- withDescription
  
  public TRSection withDescription(String description)
- getId
  
  public Long getId()
  
  The ID of the section
- setId
  
  public void setId(Long id)
  
  The ID of the section
- withId
  
  public TRSection withId(Long id)
- getSuiteId
  
  public Long getSuiteId()
  
  The ID of the test suite (ignored if the project is operating in single suite mode, required otherwise)
- setSuiteId
  
  public void setSuiteId(Long suiteId)
  
  The ID of the test suite (ignored if the project is operating in single suite mode, required otherwise)
- withSuiteId
  
  public TRSection withSuiteId(Long suiteId)
- getParentId
  
  public Long getParentId()
  
  The ID of the parent section (to build section hierarchies)
- setParentId
  
  public void setParentId(Long parentId)
  
  The ID of the parent section (to build section hierarchies)
- withParentId
  
  public TRSection withParentId(Long parentId)
- getName
  
  public String getName()
  
  The name of the section (required) (Required)
- setName
  
  public void setName(String name)
  
  The name of the section (required) (Required)
- withName
  
  public TRSection withName(String name)
- getDepth
  
  public Long getDepth()
  
  The level in the section hierarchy of the test suite
- setDepth
  
  public void setDepth(Long depth)
  
  The level in the section hierarchy of the test suite
- withDepth
  
  public TRSection withDepth(Long depth)
- getDisplayOrder
  
  public Long getDisplayOrder()
  
  The order in the test suite
- setDisplayOrder
  
  public void setDisplayOrder(Long displayOrder)
  
  The order in the test suite
- withDisplayOrder
  
  public TRSection withDisplayOrder(Long displayOrder)
- getAdditionalProperties
  
  public Map<String,Object> getAdditionalProperties()
- setAdditionalProperty
  
  public void setAdditionalProperty(String name, Object value)
- withAdditionalProperty
  
  public TRSection withAdditionalProperty(String name, Object value)
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- equals
  
  public boolean equals(Object other)
  
  Overrides:
  
  equals in class Object

Class TRSection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details