TRPlanEntry (Gson models 1.1.5-alpha API)

java.lang.Object
- org.touchbit.testrail4j.gson.model.TRPlanEntry

```
public class TRPlanEntry
extends Object
```

Constructor Summary

Constructors
Constructor and Description
`TRPlanEntry()` No args constructor for use in serialization
`TRPlanEntry(String id, Long suiteId, String name, String description, Long assignedtoId, Boolean includeAll, List<Long> caseIds, List<Long> configIds, List<TRRun> runs)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Long`	`getAssignedtoId()` The ID of the user the test run(s) should be assigned to
`List<Long>`	`getCaseIds()` An array of case IDs for the custom case selection
`List<Long>`	`getConfigIds()` An array of configuration IDs used for the test runs of the test plan entry (requires TestRail 3.1 or later)
`String`	`getDescription()` The description of the test run(s) (requires TestRail 5.2 or later)
`String`	`getId()` UUID
`Boolean`	`getIncludeAll()` True for including all test cases of the test suite and false for a custom case selection (default: true)
`String`	`getName()` The name of the test run(s)
`List<TRRun>`	`getRuns()` An array of test runs with configurations, please see the example below for details (requires TestRail 3.1 or later)
`Long`	`getSuiteId()` The ID of the test suite for the test run(s) (required) (Required)
`int`	`hashCode()`
`void`	`setAssignedtoId(Long assignedtoId)` The ID of the user the test run(s) should be assigned to
`void`	`setCaseIds(List<Long> caseIds)` An array of case IDs for the custom case selection
`void`	`setConfigIds(List<Long> configIds)` An array of configuration IDs used for the test runs of the test plan entry (requires TestRail 3.1 or later)
`void`	`setDescription(String description)` The description of the test run(s) (requires TestRail 5.2 or later)
`void`	`setId(String id)` UUID
`void`	`setIncludeAll(Boolean includeAll)` True for including all test cases of the test suite and false for a custom case selection (default: true)
`void`	`setName(String name)` The name of the test run(s)
`void`	`setRuns(List<TRRun> runs)` An array of test runs with configurations, please see the example below for details (requires TestRail 3.1 or later)
`void`	`setSuiteId(Long suiteId)` The ID of the test suite for the test run(s) (required) (Required)
`String`	`toString()`
`TRPlanEntry`	`withAssignedtoId(Long assignedtoId)`
`TRPlanEntry`	`withCaseIds(List<Long> caseIds)`
`TRPlanEntry`	`withConfigIds(List<Long> configIds)`
`TRPlanEntry`	`withDescription(String description)`
`TRPlanEntry`	`withId(String id)`
`TRPlanEntry`	`withIncludeAll(Boolean includeAll)`
`TRPlanEntry`	`withName(String name)`
`TRPlanEntry`	`withRuns(List<TRRun> runs)`
`TRPlanEntry`	`withSuiteId(Long suiteId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TRPlanEntry
```
public TRPlanEntry()
```
No args constructor for use in serialization

TRPlanEntry

public TRPlanEntry(String id,
                   Long suiteId,
                   String name,
                   String description,
                   Long assignedtoId,
                   Boolean includeAll,
                   List<Long> caseIds,
                   List<Long> configIds,
                   List<TRRun> runs)

Parameters:: suiteId -; assignedtoId -; name -; description -; includeAll -; caseIds -; configIds -; id -; runs -

Method Detail
- getId
```
public String getId()
```
  UUID
- setId
```
public void setId(String id)
```
  UUID
- withId
```
public TRPlanEntry withId(String id)
```
- getSuiteId
```
public Long getSuiteId()
```
  The ID of the test suite for the test run(s) (required) (Required)
- setSuiteId
```
public void setSuiteId(Long suiteId)
```
  The ID of the test suite for the test run(s) (required) (Required)
- withSuiteId
```
public TRPlanEntry withSuiteId(Long suiteId)
```
- getName
```
public String getName()
```
  The name of the test run(s)
- setName
```
public void setName(String name)
```
  The name of the test run(s)
- withName
```
public TRPlanEntry withName(String name)
```
- getDescription
```
public String getDescription()
```
  The description of the test run(s) (requires TestRail 5.2 or later)
- setDescription
```
public void setDescription(String description)
```
  The description of the test run(s) (requires TestRail 5.2 or later)
- withDescription
```
public TRPlanEntry withDescription(String description)
```
- getAssignedtoId
```
public Long getAssignedtoId()
```
  The ID of the user the test run(s) should be assigned to
- setAssignedtoId
```
public void setAssignedtoId(Long assignedtoId)
```
  The ID of the user the test run(s) should be assigned to
- withAssignedtoId
```
public TRPlanEntry withAssignedtoId(Long assignedtoId)
```
- getIncludeAll
```
public Boolean getIncludeAll()
```
  True for including all test cases of the test suite and false for a custom case selection (default: true)
- setIncludeAll
```
public void setIncludeAll(Boolean includeAll)
```
  True for including all test cases of the test suite and false for a custom case selection (default: true)
- withIncludeAll
```
public TRPlanEntry withIncludeAll(Boolean includeAll)
```
- getCaseIds
```
public List<Long> getCaseIds()
```
  An array of case IDs for the custom case selection
- setCaseIds
```
public void setCaseIds(List<Long> caseIds)
```
  An array of case IDs for the custom case selection
- withCaseIds
```
public TRPlanEntry withCaseIds(List<Long> caseIds)
```
- getConfigIds
```
public List<Long> getConfigIds()
```
  An array of configuration IDs used for the test runs of the test plan entry (requires TestRail 3.1 or later)
- setConfigIds
```
public void setConfigIds(List<Long> configIds)
```
  An array of configuration IDs used for the test runs of the test plan entry (requires TestRail 3.1 or later)
- withConfigIds
```
public TRPlanEntry withConfigIds(List<Long> configIds)
```
- getRuns
```
public List<TRRun> getRuns()
```
  An array of test runs with configurations, please see the example below for details (requires TestRail 3.1 or later)
- setRuns
```
public void setRuns(List<TRRun> runs)
```
  An array of test runs with configurations, please see the example below for details (requires TestRail 3.1 or later)
- withRuns
```
public TRPlanEntry withRuns(List<TRRun> runs)
```
- 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 TRPlanEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TRPlanEntry

TRPlanEntry

Method Detail

getId

setId

withId

getSuiteId

setSuiteId

withSuiteId

getName

setName

withName

getDescription

setDescription

withDescription

getAssignedtoId

setAssignedtoId

withAssignedtoId

getIncludeAll

setIncludeAll

withIncludeAll

getCaseIds

setCaseIds

withCaseIds

getConfigIds

setConfigIds

withConfigIds

getRuns

setRuns

withRuns

toString

hashCode

equals