org.touchbit.testrail4j.jackson2.model.TRCaseField

public class TRCaseField
extends Object

Case custom field. See http://docs.gurock.com/testrail-api2/reference-cases-fields#add_case_field

Constructor Summary

Constructors
Constructor	Description
`TRCaseField()`	No args constructor for use in serialization
`TRCaseField(List<TRCaseFieldConfig> configs, String description, Long displayOrder, Long id, Long isMulti, Boolean isActive, Long statusId, Long isSystem, Long entityId, String label, String name, String systemName, String type, Long typeId, Long locationId, Boolean includeAll, List<Long> templateIds)`

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(Object other)`
`Map<String,Object>`	`getAdditionalProperties()`
`List<TRCaseFieldConfig>`	`getConfigs()`	An object wrapped in an array with two default keys, 'context' and 'options'
`String`	`getDescription()`	The description for the new custom field
`Long`	`getDisplayOrder()`
`Long`	`getEntityId()`
`Long`	`getId()`
`Boolean`	`getIncludeAll()`	Set flag to true if you want the new custom field included for all templates.
`Boolean`	`getIsActive()`
`Long`	`getIsMulti()`
`Long`	`getIsSystem()`
`String`	`getLabel()`	The label for custom field (Required)
`Long`	`getLocationId()`	See FieldTypes class
`String`	`getName()`	The name for custom field (Required)
`Long`	`getStatusId()`
`String`	`getSystemName()`	The system name for custom field
`List<Long>`	`getTemplateIds()`	ID's of templates new custom field will apply to if include_all is set to false
`String`	`getType()`	See FieldTypes class.
`Long`	`getTypeId()`	See FieldTypes class (Required)
`int`	`hashCode()`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setConfigs(List<TRCaseFieldConfig> configs)`	An object wrapped in an array with two default keys, 'context' and 'options'
`void`	`setDescription(String description)`	The description for the new custom field
`void`	`setDisplayOrder(Long displayOrder)`
`void`	`setEntityId(Long entityId)`
`void`	`setId(Long id)`
`void`	`setIncludeAll(Boolean includeAll)`	Set flag to true if you want the new custom field included for all templates.
`void`	`setIsActive(Boolean isActive)`
`void`	`setIsMulti(Long isMulti)`
`void`	`setIsSystem(Long isSystem)`
`void`	`setLabel(String label)`	The label for custom field (Required)
`void`	`setLocationId(Long locationId)`	See FieldTypes class
`void`	`setName(String name)`	The name for custom field (Required)
`void`	`setStatusId(Long statusId)`
`void`	`setSystemName(String systemName)`	The system name for custom field
`void`	`setTemplateIds(List<Long> templateIds)`	ID's of templates new custom field will apply to if include_all is set to false
`void`	`setType(String type)`	See FieldTypes class.
`void`	`setTypeId(Long typeId)`	See FieldTypes class (Required)
`String`	`toString()`
`TRCaseField`	`withAdditionalProperty(String name, Object value)`
`TRCaseField`	`withConfigs(List<TRCaseFieldConfig> configs)`
`TRCaseField`	`withDescription(String description)`
`TRCaseField`	`withDisplayOrder(Long displayOrder)`
`TRCaseField`	`withEntityId(Long entityId)`
`TRCaseField`	`withId(Long id)`
`TRCaseField`	`withIncludeAll(Boolean includeAll)`
`TRCaseField`	`withIsActive(Boolean isActive)`
`TRCaseField`	`withIsMulti(Long isMulti)`
`TRCaseField`	`withIsSystem(Long isSystem)`
`TRCaseField`	`withLabel(String label)`
`TRCaseField`	`withLocationId(Long locationId)`
`TRCaseField`	`withName(String name)`
`TRCaseField`	`withStatusId(Long statusId)`
`TRCaseField`	`withSystemName(String systemName)`
`TRCaseField`	`withTemplateIds(List<Long> templateIds)`
`TRCaseField`	`withType(String type)`
`TRCaseField`	`withTypeId(Long typeId)`

Methods inherited from class java.lang.Object

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

Constructor Details
- TRCaseField
  
  public TRCaseField()
  
  No args constructor for use in serialization
- TRCaseField
  
  public TRCaseField(List<TRCaseFieldConfig> configs, String description, Long displayOrder, Long id, Long isMulti, Boolean isActive, Long statusId, Long isSystem, Long entityId, String label, String name, String systemName, String type, Long typeId, Long locationId, Boolean includeAll, List<Long> templateIds)
  
  Parameters:
  
  configs -
  
  templateIds -
  
  displayOrder -
  
  description -
  
  entityId -
  
  includeAll -
  
  label -
  
  isActive -
  
  type -
  
  isMulti -
  
  isSystem -
  
  statusId -
  
  systemName -
  
  locationId -
  
  name -
  
  typeId -
  
  id -
Method Details
- getConfigs
  
  public List<TRCaseFieldConfig> getConfigs()
  
  An object wrapped in an array with two default keys, 'context' and 'options'
- setConfigs
  
  public void setConfigs(List<TRCaseFieldConfig> configs)
  
  An object wrapped in an array with two default keys, 'context' and 'options'
- withConfigs
  
  public TRCaseField withConfigs(List<TRCaseFieldConfig> configs)
- getDescription
  
  public String getDescription()
  
  The description for the new custom field
- setDescription
  
  public void setDescription(String description)
  
  The description for the new custom field
- withDescription
  
  public TRCaseField withDescription(String description)
- getDisplayOrder
  
  public Long getDisplayOrder()
- setDisplayOrder
  
  public void setDisplayOrder(Long displayOrder)
- withDisplayOrder
  
  public TRCaseField withDisplayOrder(Long displayOrder)
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- withId
  
  public TRCaseField withId(Long id)
- getIsMulti
  
  public Long getIsMulti()
- setIsMulti
  
  public void setIsMulti(Long isMulti)
- withIsMulti
  
  public TRCaseField withIsMulti(Long isMulti)
- getIsActive
  
  public Boolean getIsActive()
- setIsActive
  
  public void setIsActive(Boolean isActive)
- withIsActive
  
  public TRCaseField withIsActive(Boolean isActive)
- getStatusId
  
  public Long getStatusId()
- setStatusId
  
  public void setStatusId(Long statusId)
- withStatusId
  
  public TRCaseField withStatusId(Long statusId)
- getIsSystem
  
  public Long getIsSystem()
- setIsSystem
  
  public void setIsSystem(Long isSystem)
- withIsSystem
  
  public TRCaseField withIsSystem(Long isSystem)
- getEntityId
  
  public Long getEntityId()
- setEntityId
  
  public void setEntityId(Long entityId)
- withEntityId
  
  public TRCaseField withEntityId(Long entityId)
- getLabel
  
  public String getLabel()
  
  The label for custom field (Required)
- setLabel
  
  public void setLabel(String label)
  
  The label for custom field (Required)
- withLabel
  
  public TRCaseField withLabel(String label)
- getName
  
  public String getName()
  
  The name for custom field (Required)
- setName
  
  public void setName(String name)
  
  The name for custom field (Required)
- withName
  
  public TRCaseField withName(String name)
- getSystemName
  
  public String getSystemName()
  
  The system name for custom field
- setSystemName
  
  public void setSystemName(String systemName)
  
  The system name for custom field
- withSystemName
  
  public TRCaseField withSystemName(String systemName)
- getType
  
  public String getType()
  
  See FieldTypes class. You can pass the number of the type as well as the word, e.g. 5, string, String, Dropdown, 12. The numbers must be sent as a string e.g {type: "5"} not {type: 5}, otherwise you will get a 400 (Bad Request) response.
- setType
  
  public void setType(String type)
  
  See FieldTypes class. You can pass the number of the type as well as the word, e.g. 5, string, String, Dropdown, 12. The numbers must be sent as a string e.g {type: "5"} not {type: 5}, otherwise you will get a 400 (Bad Request) response.
- withType
  
  public TRCaseField withType(String type)
- getTypeId
  
  public Long getTypeId()
  
  See FieldTypes class (Required)
- setTypeId
  
  public void setTypeId(Long typeId)
  
  See FieldTypes class (Required)
- withTypeId
  
  public TRCaseField withTypeId(Long typeId)
- getLocationId
  
  public Long getLocationId()
  
  See FieldTypes class
- setLocationId
  
  public void setLocationId(Long locationId)
  
  See FieldTypes class
- withLocationId
  
  public TRCaseField withLocationId(Long locationId)
- getIncludeAll
  
  public Boolean getIncludeAll()
  
  Set flag to true if you want the new custom field included for all templates. Otherwise (false) specify the ID's of templates to be included as the next parameter (template_ids)
- setIncludeAll
  
  public void setIncludeAll(Boolean includeAll)
  
  Set flag to true if you want the new custom field included for all templates. Otherwise (false) specify the ID's of templates to be included as the next parameter (template_ids)
- withIncludeAll
  
  public TRCaseField withIncludeAll(Boolean includeAll)
- getTemplateIds
  
  public List<Long> getTemplateIds()
  
  ID's of templates new custom field will apply to if include_all is set to false
- setTemplateIds
  
  public void setTemplateIds(List<Long> templateIds)
  
  ID's of templates new custom field will apply to if include_all is set to false
- withTemplateIds
  
  public TRCaseField withTemplateIds(List<Long> templateIds)
- getAdditionalProperties
  
  public Map<String,Object> getAdditionalProperties()
- setAdditionalProperty
  
  public void setAdditionalProperty(String name, Object value)
- withAdditionalProperty
  
  public TRCaseField 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 TRCaseField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details