Record (kintone-java-client 2.1.0 API)

Object
- Record

```
public class Record
extends Object
```
A Record represents a Record data.
Retrieved Records
This class is used as the responded record objects of GET Record API and GET Records API.
A value of any field in a record can be obtained by getFieldValue(String) with its field code, except for "$id" and "$revision" fields. These fields are decoded specially into dedicated data and can be obtained by getId() and getRevision() each.
getFieldValue(String) returns implementation classes of FieldValue, which wrap the actual field value of String, BigDecimal and etc into a class depending on the field type. For the convenience, get{FIELD_TYPE}FieldValue(String) methods, such as getSingleLineTextFieldValue(String), allow you to directly get unwrapped values.
With GET Records API, retrieved records might not contain all the fields of the App. This REST API returns the fields only specified in "fields" request parameter if it specified. Therefore, the corresponding Record objects also has only the specified fields. If "$id" and "$revision" is not specified in "fields" parameter, getId() and getRevision() will be return null, respectively.
```
 List<Record> records = client.record().getRecords(app, Arrays.asList("field1"), 1, 0);
 records.get(0).getFieldValue("field1"); // returns the value of "field1"
 records.get(0).getId();                 // will be null, the response only contains the value of "field1"
 records.get(0).getFieldValue("field2"); // also, null
 
```
Modifying Records
To add or update records, setup record objects with Record() and putField(String, FieldValue).
```
 // Creates a record object
 Record record = new Record();

 // "number" and "text" are the field codes of the Number and Text field, respectively.
 record.putField("number", new NumberFieldValue(30));
 record.putField("text", new SingleLineTextFieldValue("Hello"));
 
```
You can also create the record object from a retrieved record. In such a case, you may use newFrom(Record) to create the object.
```
 // Gets a record
 Record record = client.record().getRecord(1, 100);

 // Creates new Record object from the retrieved record,
 // copying without built-in fields, namely Record Number and Created date and time.
 Record copiedRecord = Record.newFrom(record);

 // Adds the record
 long recordId = client.record().addRecord(1, copiedRecord);
 
```
Retrieved records may contain some built-in fields that will cause errors when sent them as is to add or update records. newFrom(Record) create a new record object from the source record without built-in fields to prevent those errors.
Note that Kintone only allows to set the value of some built-in field (specifically, Creator, Modifier, and Created or Updated date-time field) when adding a new record as an administrator of the App.

Constructor Summary

Constructors
Constructor and Description

Record()
Constructor for creating or updating a record.

Record(Long id, Long revision)
Constructor to set the ID and revision data.

Constructors
Constructor and Description
`Record()` Constructor for creating or updating a record.
`Record(Long id, Long revision)` Constructor to set the ID and revision data.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCalcFieldValue(String fieldCode)` Returns the value of a Calculated field.
`List<String>`	`getCategoryFieldValue()` Returns the value of the Category field.
`List<String>`	`getCheckBoxFieldValue(String fieldCode)` Returns the value of a Checkbox field.
`ZonedDateTime`	`getCreatedTimeFieldValue()` Returns the value of the Created date-time field.
`User`	`getCreatorFieldValue()` Returns the value of the Creator field.
`LocalDate`	`getDateFieldValue(String fieldCode)` Returns the value of a Date field.
`ZonedDateTime`	`getDateTimeFieldValue(String fieldCode)` Returns the value of a Date and time field.
`String`	`getDropDownFieldValue(String fieldCode)` Returns the value of a Drop-down field.
`Set<String>`	`getFieldCodes(boolean includeBuiltins)` Returns field codes stored in the record object.
`FieldType`	`getFieldType(String fieldCode)` Returns the field type of the field.
`FieldValue`	`getFieldValue(String fieldCode)` Returns the value of the specified field.
`List<FileBody>`	`getFileFieldValue(String fieldCode)` Returns the value of an Attachment field.
`List<Group>`	`getGroupSelectFieldValue(String fieldCode)` Returns the value of a Group Selection field.
`Long`	`getId()` Returns the record ID.
`String`	`getLinkFieldValue(String fieldCode)` Returns the value of a Link field.
`User`	`getModifierFieldValue()` Returns the value of the Modifier field.
`String`	`getMultiLineTextFieldValue(String fieldCode)` Returns the value of a Text Area field.
`List<String>`	`getMultiSelectFieldValue(String fieldCode)` Returns the value of a Multi-choice field.
`BigDecimal`	`getNumberFieldValue(String fieldCode)` Returns the value of a Number field.
`List<Organization>`	`getOrganizationSelectFieldValue(String fieldCode)` Returns the value of a Department Selection field.
`String`	`getRadioButtonFieldValue(String fieldCode)` Returns the value of a Radio button field.
`String`	`getRecordNumberFieldValue()` Returns the value of the Record number field.
`Long`	`getRevision()` Returns the record revision.
`String`	`getRichTextFieldValue(String fieldCode)` Returns the value of a Rich text field.
`String`	`getSingleLineTextFieldValue(String fieldCode)` Returns the value of a Text field.
`List<User>`	`getStatusAssigneeFieldValue()` Returns the value of the Assignee of the Process management status field.
`String`	`getStatusFieldValue()` Returns the value of the Process management status field.
`List<TableRow>`	`getSubtableFieldValue(String fieldCode)` Returns the value of a Table.
`LocalTime`	`getTimeFieldValue(String fieldCode)` Returns the value of a Time field.
`ZonedDateTime`	`getUpdatedTimeFieldValue()` Returns the value of the Updated date-time field.
`List<User>`	`getUserSelectFieldValue(String fieldCode)` Returns the value of a User Selection field.
`static Record`	`newFrom(Record src)` Copies a record without built-in fields.
`Record`	`putField(String fieldCode, FieldValue value)` Set the value of a field.
`Record`	`removeField(String fieldCode)` Remove a field from the record object.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Record
```
public Record()
```
    Constructor for creating or updating a record. This constructor does not set the ID and revision data of creating instance. getId() and getRevision() will return null.
  - Record
```
public Record(Long id,
              Long revision)
```
    Constructor to set the ID and revision data. This constructor is mainly for internal use and for testing. To get a new instance for creating or updating a record, simply use Record().
    
    Parameters:
    
    id - the record ID
    
    revision - the revision of the record
- Method Detail
  - newFrom
```
public static Record newFrom(Record src)
```
    Copies a record without built-in fields.
    
    Parameters:
    
    src - the source record
    
    Returns:
    
    new record object with non built-in fields of src
  - getId
```
public Long getId()
```
    Returns the record ID.
    
    Returns:
    
    the record ID
  - getRevision
```
public Long getRevision()
```
    Returns the record revision.
    
    Returns:
    
    the record revision
  - putField
```
public Record putField(String fieldCode,
                       FieldValue value)
```
    Set the value of a field.
    
    Parameters:
    
    fieldCode - the field code
    
    value - the value of the field
    
    Returns:
    
    this record object
  - removeField
```
public Record removeField(String fieldCode)
```
    Remove a field from the record object.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    this record object
  - getFieldValue
```
public FieldValue getFieldValue(String fieldCode)
```
    Returns the value of the specified field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    field value
  - getFieldCodes
```
public Set<String> getFieldCodes(boolean includeBuiltins)
```
    Returns field codes stored in the record object.
    
    Parameters:
    
    includeBuiltins - true to include field code of built-in fields, false to get only non built-in fields. "$id" and "$revision" are not included in either case.
    
    Returns:
    
    a set of field codes
  - getFieldType
```
public FieldType getFieldType(String fieldCode)
```
    Returns the field type of the field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the type of the field
  - getSingleLineTextFieldValue
```
public String getSingleLineTextFieldValue(String fieldCode)
```
    Returns the value of a Text field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getSubtableFieldValue
```
public List<TableRow> getSubtableFieldValue(String fieldCode)
```
    Returns the value of a Table.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getLinkFieldValue
```
public String getLinkFieldValue(String fieldCode)
```
    Returns the value of a Link field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getGroupSelectFieldValue
```
public List<Group> getGroupSelectFieldValue(String fieldCode)
```
    Returns the value of a Group Selection field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getMultiSelectFieldValue
```
public List<String> getMultiSelectFieldValue(String fieldCode)
```
    Returns the value of a Multi-choice field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getRadioButtonFieldValue
```
public String getRadioButtonFieldValue(String fieldCode)
```
    Returns the value of a Radio button field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getDateFieldValue
```
public LocalDate getDateFieldValue(String fieldCode)
```
    Returns the value of a Date field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getOrganizationSelectFieldValue
```
public List<Organization> getOrganizationSelectFieldValue(String fieldCode)
```
    Returns the value of a Department Selection field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getDateTimeFieldValue
```
public ZonedDateTime getDateTimeFieldValue(String fieldCode)
```
    Returns the value of a Date and time field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getUserSelectFieldValue
```
public List<User> getUserSelectFieldValue(String fieldCode)
```
    Returns the value of a User Selection field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getCheckBoxFieldValue
```
public List<String> getCheckBoxFieldValue(String fieldCode)
```
    Returns the value of a Checkbox field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getCalcFieldValue
```
public String getCalcFieldValue(String fieldCode)
```
    Returns the value of a Calculated field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getTimeFieldValue
```
public LocalTime getTimeFieldValue(String fieldCode)
```
    Returns the value of a Time field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getNumberFieldValue
```
public BigDecimal getNumberFieldValue(String fieldCode)
```
    Returns the value of a Number field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getDropDownFieldValue
```
public String getDropDownFieldValue(String fieldCode)
```
    Returns the value of a Drop-down field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getMultiLineTextFieldValue
```
public String getMultiLineTextFieldValue(String fieldCode)
```
    Returns the value of a Text Area field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getRichTextFieldValue
```
public String getRichTextFieldValue(String fieldCode)
```
    Returns the value of a Rich text field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getFileFieldValue
```
public List<FileBody> getFileFieldValue(String fieldCode)
```
    Returns the value of an Attachment field.
    
    Parameters:
    
    fieldCode - the field code
    
    Returns:
    
    the value of the field
  - getCategoryFieldValue
```
public List<String> getCategoryFieldValue()
```
    Returns the value of the Category field.
    
    Returns:
    
    the value of the field
  - getCreatedTimeFieldValue
```
public ZonedDateTime getCreatedTimeFieldValue()
```
    Returns the value of the Created date-time field.
    
    Returns:
    
    the value of the field
  - getCreatorFieldValue
```
public User getCreatorFieldValue()
```
    Returns the value of the Creator field.
    
    Returns:
    
    the value of the field
  - getModifierFieldValue
```
public User getModifierFieldValue()
```
    Returns the value of the Modifier field.
    
    Returns:
    
    the value of the field
  - getRecordNumberFieldValue
```
public String getRecordNumberFieldValue()
```
    Returns the value of the Record number field.
    
    Returns:
    
    the value of the field
  - getStatusFieldValue
```
public String getStatusFieldValue()
```
    Returns the value of the Process management status field.
    
    Returns:
    
    the value of the field
  - getStatusAssigneeFieldValue
```
public List<User> getStatusAssigneeFieldValue()
```
    Returns the value of the Assignee of the Process management status field.
    
    Returns:
    
    the value of the field
  - getUpdatedTimeFieldValue
```
public ZonedDateTime getUpdatedTimeFieldValue()
```
    Returns the value of the Updated date-time field.
    
    Returns:
    
    the value of the field

Class Record

Retrieved Records

Modifying Records

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Record

Record

Method Detail

newFrom

getId

getRevision

putField

removeField

getFieldValue

getFieldCodes

getFieldType

getSingleLineTextFieldValue

getSubtableFieldValue

getLinkFieldValue

getGroupSelectFieldValue

getMultiSelectFieldValue

getRadioButtonFieldValue

getDateFieldValue

getOrganizationSelectFieldValue

getDateTimeFieldValue

getUserSelectFieldValue

getCheckBoxFieldValue

getCalcFieldValue

getTimeFieldValue

getNumberFieldValue

getDropDownFieldValue

getMultiLineTextFieldValue

getRichTextFieldValue

getFileFieldValue

getCategoryFieldValue

getCreatedTimeFieldValue

getCreatorFieldValue

getModifierFieldValue

getRecordNumberFieldValue

getStatusFieldValue

getStatusAssigneeFieldValue

getUpdatedTimeFieldValue