Field (qtest-sdk-java 1.4.10 API)

java.lang.Object
- org.qas.api.internal.PropertyContainer
- - org.qas.qtest.api.internal.model.QTestBaseModel<Field>
  - - org.qas.qtest.api.internal.model.Field

All Implemented Interfaces:

java.lang.Cloneable
```
public class Field
extends QTestBaseModel<Field>
```
Field

Since:

1.0

Field Summary
- Fields inherited from class org.qas.api.internal.PropertyContainer
  NL, properties, RESERVED_NAME

Constructor Summary

Constructors
Constructor and Description

Field()
Creates the field instance.

Constructors
Constructor and Description
`Field()` Creates the field instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Field`	`addAllowedValue(AllowedValue allowedValue)` Add allowed value to field.
`Field`	`clone()`
`java.lang.String`	`elementName()`
`java.util.List<AllowedValue>`	`getAllowedValues()` Return the list of allowed values.
`java.lang.String`	`getAttributeType()`
`DataType`	`getDataType()`
`int`	`getDataTypeId()`
`java.lang.Long`	`getId()`
`java.lang.String`	`getLabel()`
`java.lang.Integer`	`getOrder()`
`java.lang.String`	`getOriginName()`
`java.lang.String`	`getSearchKey()`
`java.lang.Boolean`	`isActive()`
`java.lang.Boolean`	`isConstrained()`
`java.lang.Boolean`	`isFreeTextSearch()`
`java.lang.Boolean`	`isMultiple()`
`java.lang.Boolean`	`isRequired()`
`java.lang.Boolean`	`isSearchable()`
`java.lang.Boolean`	`isSystemField()`
`Field`	`setActive(java.lang.Boolean active)`
`Field`	`setAllowedValues(java.util.List<AllowedValue> allowedValues)` Sets the list of allowed value objects.
`Field`	`setAttributeType(java.lang.String attributeType)` Sets the attribute type.
`Field`	`setConstrained(java.lang.Boolean constrained)` Sets the field constrained value.
`Field`	`setDataType(DataType dataType)` Sets the field data type.
`Field`	`setDataTypeId(int dataTypeId)`
`Field`	`setFreeTextSearch(java.lang.Boolean freeTextSearch)` Sets the free text search flag value.
`Field`	`setId(java.lang.Long id)` Sets the field identifier value.
`Field`	`setLabel(java.lang.String label)` Sets field label.
`Field`	`setMultiple(java.lang.Boolean multiple)` Sets the multiple flag value.
`Field`	`setOrder(java.lang.Integer order)` Sets the field order.
`Field`	`setOriginName(java.lang.String originName)`
`Field`	`setRequired(java.lang.Boolean required)` Sets the required flag.
`Field`	`setSearchable(java.lang.Boolean searchable)` Sets the field searchable flag value.
`Field`	`setSearchKey(java.lang.String searchKey)` Sets the field search key value.
`Field`	`setSystemField(java.lang.Boolean systemField)` Sets the system field flag.
`java.lang.String`	`toString()`
`Field`	`withActive(java.lang.Boolean active)`
`Field`	`withAllowedValues(java.util.List<AllowedValue> allowedValues)` Sets the list of allowed value objects and return itself.
`Field`	`withAttributeType(java.lang.String attributeType)` Sets the attribute type value and return itself.
`Field`	`withConstrained(java.lang.Boolean constrained)` Sets the field constrained value and return itself.
`Field`	`withDataType(DataType dataType)` Sets the field data type and return current instance.
`Field`	`withFreeTextSearch(java.lang.Boolean freeTextSearch)` Sets the free text search flag value and return current field instance.
`Field`	`withId(java.lang.Long id)` Sets the field identifier value and return itself.
`Field`	`withLabel(java.lang.String label)` Sets the field label value and return itself.
`Field`	`withMultiple(java.lang.Boolean multiple)` Sets the multiple flag value and return itself.
`Field`	`withOrder(java.lang.Integer order)` Sets the field order and return itself.
`Field`	`withOriginName(java.lang.String originName)`
`Field`	`withRequired(java.lang.Boolean required)` Sets the required flag and return itself.
`Field`	`withSearchable(java.lang.Boolean searchable)` Sets the field searchable flag value and return itself.
`Field`	`withSearchKey(java.lang.String searchKey)` Sets the field search key value and return itself.
`Field`	`withSystemField(java.lang.Boolean systemField)` Sets the system field flag and return field instance.

Methods inherited from class org.qas.qtest.api.internal.model.QTestBaseModel
getBinaryFromInputStream, getLinks, getWebUrl, setLinks, setWebUrl, validateInputStream, withLinks, withWebUrl

Methods inherited from class org.qas.api.internal.PropertyContainer
appendPropertiesTo, appendPropertiesTo, asDate, asDate, asInteger, asInteger, asLong, asLong, asString, asString, getProperties, getProperty, getPropertyMap, hasProperties, hasProperty, isVisible, jsonElementName, removeProperty, setPropertiesFrom, setProperty, toJson

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

- Constructor Detail
  - Field
```
public Field()
```
    Creates the field instance.
- Method Detail
  - getId
```
public java.lang.Long getId()
```
    Returns:
    
    the field identifier value.
  - setId
```
public Field setId(java.lang.Long id)
```
    Sets the field identifier value.
    
    Parameters:
    
    id - the given field identifier value to set.
    
    Returns:
    
    the current instance.
  - withId
```
public Field withId(java.lang.Long id)
```
    Sets the field identifier value and return itself.
    
    Parameters:
    
    id - the given field identifier value to set.
    
    Returns:
    
    the field instance.
  - getLabel
```
public java.lang.String getLabel()
```
    Returns:
    
    the field label value.
  - setLabel
```
public Field setLabel(java.lang.String label)
```
    Sets field label.
    
    Parameters:
    
    label - the given field label value to set.
    
    Returns:
    
    the current instance.
  - withLabel
```
public Field withLabel(java.lang.String label)
```
    Sets the field label value and return itself.
    
    Parameters:
    
    label - the given field label value.
    
    Returns:
    
    the current field instance.
  - getOriginName
```
public java.lang.String getOriginName()
```
    Returns:
    
    originName
  - setOriginName
```
public Field setOriginName(java.lang.String originName)
```
    Parameters:
    
    originName - originName
    
    Returns:
    
    the current instance.
  - withOriginName
```
public Field withOriginName(java.lang.String originName)
```
    Parameters:
    
    originName - originName
    
    Returns:
    
    the current instance.
  - isRequired
```
public java.lang.Boolean isRequired()
```
    Returns:
    
    the flag that mark this field is required.
  - setRequired
```
public Field setRequired(java.lang.Boolean required)
```
    Sets the required flag.
    
    Parameters:
    
    required - the given required flag value to set.
    
    Returns:
    
    the current instance.
  - withRequired
```
public Field withRequired(java.lang.Boolean required)
```
    Sets the required flag and return itself.
    
    Parameters:
    
    required - the givne required flag value to set.
    
    Returns:
    
    the current field istance.
  - isConstrained
```
public java.lang.Boolean isConstrained()
```
    Returns:
    
    the field constrained flag.
  - setConstrained
```
public Field setConstrained(java.lang.Boolean constrained)
```
    Sets the field constrained value.
    
    Parameters:
    
    constrained - the given field constrained value to set.
    
    Returns:
    
    the current instance.
  - withConstrained
```
public Field withConstrained(java.lang.Boolean constrained)
```
    Sets the field constrained value and return itself.
    
    Parameters:
    
    constrained - the given field constrained value to set.
    
    Returns:
    
    the field instance.
  - isSearchable
```
public java.lang.Boolean isSearchable()
```
    Returns:
    
    if the field can searchable.
  - setSearchable
```
public Field setSearchable(java.lang.Boolean searchable)
```
    Sets the field searchable flag value.
    
    Parameters:
    
    searchable - the given searchable flag value to set.
    
    Returns:
    
    the current instance.
  - withSearchable
```
public Field withSearchable(java.lang.Boolean searchable)
```
    Sets the field searchable flag value and return itself.
    
    Parameters:
    
    searchable - the given searchable flag value to set.
    
    Returns:
    
    the current field instance.
  - isFreeTextSearch
```
public java.lang.Boolean isFreeTextSearch()
```
    Returns:
    
    if the field support free text search.
  - setFreeTextSearch
```
public Field setFreeTextSearch(java.lang.Boolean freeTextSearch)
```
    Sets the free text search flag value.
    
    Parameters:
    
    freeTextSearch - the given free text search flag value to set.
    
    Returns:
    
    the current instance.
  - withFreeTextSearch
```
public Field withFreeTextSearch(java.lang.Boolean freeTextSearch)
```
    Sets the free text search flag value and return current field instance.
    
    Parameters:
    
    freeTextSearch - the given free text search flag value to set.
    
    Returns:
    
    current field instance.
  - getSearchKey
```
public java.lang.String getSearchKey()
```
    Returns:
    
    the field search key.
  - setSearchKey
```
public Field setSearchKey(java.lang.String searchKey)
```
    Sets the field search key value.
    
    Parameters:
    
    searchKey - the given search key value to set.
    
    Returns:
    
    the current instance.
  - withSearchKey
```
public Field withSearchKey(java.lang.String searchKey)
```
    Sets the field search key value and return itself.
    
    Parameters:
    
    searchKey - the given search key value to set.
    
    Returns:
    
    current field instance.
  - getDataTypeId
```
public int getDataTypeId()
```
  - getDataType
```
public DataType getDataType()
```
    Returns:
    
    the current field data type.
  - setDataTypeId
```
public Field setDataTypeId(int dataTypeId)
```
  - setDataType
```
public Field setDataType(DataType dataType)
```
    Sets the field data type.
    
    Parameters:
    
    dataType - the given field data type.
    
    Returns:
    
    the current instance.
  - withDataType
```
public Field withDataType(DataType dataType)
```
    Sets the field data type and return current instance.
    
    Parameters:
    
    dataType - the given field data type.
    
    Returns:
    
    the current instance.
  - getOrder
```
public java.lang.Integer getOrder()
```
    Returns:
    
    the field order.
  - setOrder
```
public Field setOrder(java.lang.Integer order)
```
    Sets the field order.
    
    Parameters:
    
    order - the given field order value to set.
    
    Returns:
    
    the current instance.
  - withOrder
```
public Field withOrder(java.lang.Integer order)
```
    Sets the field order and return itself.
    
    Parameters:
    
    order - the given field order value to set.
    
    Returns:
    
    the current field instance.
  - isMultiple
```
public java.lang.Boolean isMultiple()
```
    Returns:
    
    the multiple value.
  - setMultiple
```
public Field setMultiple(java.lang.Boolean multiple)
```
    Sets the multiple flag value.
    
    Parameters:
    
    multiple - the given multiple flag value to set.
    
    Returns:
    
    the current instance.
  - withMultiple
```
public Field withMultiple(java.lang.Boolean multiple)
```
    Sets the multiple flag value and return itself.
    
    Parameters:
    
    multiple - the given multiple flag value to set.
    
    Returns:
    
    the current field instance.
  - getAttributeType
```
public java.lang.String getAttributeType()
```
    Returns:
    
    the field attribute type.
  - setAttributeType
```
public Field setAttributeType(java.lang.String attributeType)
```
    Sets the attribute type.
    
    Parameters:
    
    attributeType - the given attribute type to set.
    
    Returns:
    
    the current instance.
  - withAttributeType
```
public Field withAttributeType(java.lang.String attributeType)
```
    Sets the attribute type value and return itself.
    
    Parameters:
    
    attributeType - the given attribute type value to set.
    
    Returns:
    
    the field instance.
  - isSystemField
```
public java.lang.Boolean isSystemField()
```
    Returns:
    
    if the field is system field.
  - setSystemField
```
public Field setSystemField(java.lang.Boolean systemField)
```
    Sets the system field flag.
    
    Parameters:
    
    systemField - the given flag that mark the field is system field or not.
    
    Returns:
    
    the current instance.
  - withSystemField
```
public Field withSystemField(java.lang.Boolean systemField)
```
    Sets the system field flag and return field instance.
    
    Parameters:
    
    systemField - the given flag that mark the field is system field or not.
    
    Returns:
    
    current field instance.
  - isActive
```
public java.lang.Boolean isActive()
```
    Returns:
  - setActive
```
public Field setActive(java.lang.Boolean active)
```
    Parameters:
    
    active - active
    
    Returns:
    
    the current instance.
  - withActive
```
public Field withActive(java.lang.Boolean active)
```
    Parameters:
    
    active - active
    
    Returns:
    
    the current instance.
  - getAllowedValues
```
public java.util.List<AllowedValue> getAllowedValues()
```
    Return the list of allowed values.
    
    Returns:
  - setAllowedValues
```
public Field setAllowedValues(java.util.List<AllowedValue> allowedValues)
```
    Sets the list of allowed value objects.
    
    Parameters:
    
    allowedValues - the given the list of allowed value objects to set.
    
    Returns:
    
    the current instance.
  - withAllowedValues
```
public Field withAllowedValues(java.util.List<AllowedValue> allowedValues)
```
    Sets the list of allowed value objects and return itself.
    
    Parameters:
    
    allowedValues - the given list of allowed value objects to set.
    
    Returns:
    
    the current field instance.
  - addAllowedValue
```
public Field addAllowedValue(AllowedValue allowedValue)
```
    Add allowed value to field.
    
    Parameters:
    
    allowedValue - the given allowed value object to add.
    
    Returns:
    
    the current field instance.
  - clone
```
public Field clone()
```
    Overrides:
    
    clone in class PropertyContainer
    
    Returns:
    
    the current property map.
  - elementName
```
public java.lang.String elementName()
```
    Overrides:
    
    elementName in class PropertyContainer
    
    Returns:
    
    the name of the root element.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class PropertyContainer

Class Field

Field Summary

Fields inherited from class org.qas.api.internal.PropertyContainer

Constructor Summary

Method Summary

Methods inherited from class org.qas.qtest.api.internal.model.QTestBaseModel

Methods inherited from class org.qas.api.internal.PropertyContainer

Methods inherited from class java.lang.Object

Constructor Detail

Field

Method Detail

getId

setId

withId

getLabel

setLabel

withLabel

getOriginName

setOriginName

withOriginName

isRequired

setRequired

withRequired

isConstrained

setConstrained

withConstrained

isSearchable

setSearchable

withSearchable

isFreeTextSearch

setFreeTextSearch

withFreeTextSearch

getSearchKey

setSearchKey

withSearchKey

getDataTypeId

getDataType

setDataTypeId

setDataType

withDataType

getOrder

setOrder

withOrder

isMultiple

setMultiple

withMultiple

getAttributeType

setAttributeType

withAttributeType

isSystemField

setSystemField

withSystemField

isActive

setActive

withActive

getAllowedValues

setAllowedValues

withAllowedValues

addAllowedValue

clone

elementName

toString