com.cybozu.kintone.database

Class Record

java.lang.Object

com.cybozu.kintone.database.Record

All Implemented Interfaces:

java.lang.Cloneable

public class Record
extends java.lang.Object
implements java.lang.Cloneable

A record object represents a row of the kintone application. You can retrieve or store data by using this class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATE_PATTERN
static java.lang.String	DATETIME_PATTERN

Constructor Summary

Constructors

Constructor and Description
Record()
Record(long id)
Record(long id, long revision)

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.String name, Field field) Adds a new field.
java.lang.Object	clone() Clones this instance.
java.util.Date	getDate(java.lang.String name) Gets the field value as a date object.
java.util.Date	getDateTime(java.lang.String name) Gets the field value as a date object.
java.util.Set<java.util.Map.Entry<java.lang.String,Field>>	getEntrySet() Gets the entry set of the record.
Field	getField(java.lang.String name) Gets the field object.
java.util.Set<java.lang.String>	getFieldNames() Gets the field name collection.
FieldType	getFieldType(java.lang.String name) Gets the field type of the specified field.
java.util.List<FileDto>	getFiles(java.lang.String name) Gets the field value as file list.
java.lang.Long	getId() Gets the record id.
java.lang.Long	getLong(java.lang.String name) Gets the field value as long.
java.lang.Long	getRevision() Gets the revision number.
java.lang.String	getString(java.lang.String name) Gets the field value as string.
java.util.List<java.lang.String>	getStrings(java.lang.String name) Gets the field value as string list.
java.util.List<Record>	getSubtable(java.lang.String name) Gets the field value as a sub table.
UserDto	getUser(java.lang.String name) Gets the field value as a user object.
java.util.List<UserDto>	getUsers(java.lang.String name) Gets the field value as user list.
boolean	hasField(java.lang.String name) Returns true if the field exists.
boolean	hasRevision() Returns true if the revision number is set.
boolean	isEmpty(java.lang.String name) Returns true if the field value is empty.
void	setDate(java.lang.String name, java.util.Date date) Adds a new field and sets the date value.
void	setDateTime(java.lang.String name, java.util.Date date) Adds a new field and sets the date time value.
void	setFile(java.lang.String name, java.io.File file) Adds a new field and sets the file object.
void	setFile(java.lang.String name, java.io.File file, java.lang.String contentType) Adds a new field and sets the file object.
void	setFile(java.lang.String name, java.io.InputStream file, java.lang.String fileName) Adds a new field and sets the file stream.
void	setFile(java.lang.String name, java.io.InputStream file, java.lang.String fileName, java.lang.String contentType) Adds a new field and sets the file stream.
void	setFiles(java.lang.String name, java.util.List<java.lang.String> fileKeys) Adds a new field and sets the file keys.
void	setId(long id) Sets the record id.
void	setLong(java.lang.String name, long value) Adds a new field and sets the long value.
void	setRevision(long revision) Sets the revision number.
void	setString(java.lang.String name, java.lang.String value) Adds a new field and sets the string value.
void	setStrings(java.lang.String name, java.util.List<java.lang.String> values) Adds a new field and sets the string list.
void	setSubtable(java.lang.String name, java.util.List<Record> value) Adds a new field and sets the sub table.
void	setUser(java.lang.String name, java.lang.String code) Adds a new field and sets the user object.
void	setUsers(java.lang.String name, java.util.List<java.lang.String> codes) Adds a new field and sets the user object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATETIME_PATTERN

public static final java.lang.String DATETIME_PATTERN

See Also:

Constant Field Values

DATE_PATTERN

public static final java.lang.String DATE_PATTERN

See Also:

Constant Field Values

Constructor Detail

Record

public Record()

Record

public Record(long id)

Record

public Record(long id,
              long revision)

Method Detail

clone

public java.lang.Object clone()

Clones this instance.

Overrides:

clone in class java.lang.Object

Returns:

the duplicated record object

getEntrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,Field>> getEntrySet()

Gets the entry set of the record.

Returns:

the entry set of the record

getFieldNames

public java.util.Set<java.lang.String> getFieldNames()

Gets the field name collection.

Returns:

the field names

getField

public Field getField(java.lang.String name)

Gets the field object.

Parameters:

name - field name

Returns:

the field object

addField

public void addField(java.lang.String name,
                     Field field)

Adds a new field.

Parameters:

name - field name

field - field object

setId

public void setId(long id)

Sets the record id.

Parameters:

id - record id

getId

public java.lang.Long getId()

Gets the record id.

Returns:

the record id

setRevision

public void setRevision(long revision)

Sets the revision number.

Parameters:

revision - revision number

getRevision

public java.lang.Long getRevision()

Gets the revision number.

Returns:

the revision number

hasRevision

public boolean hasRevision()

Returns true if the revision number is set.

Returns:

true if the revision number is set.

isEmpty

public boolean isEmpty(java.lang.String name)

Returns true if the field value is empty.

Parameters:

name - field name

Returns:

true if the field value is empty

hasField

public boolean hasField(java.lang.String name)

Returns true if the field exists.

Parameters:

name - field name

Returns:

true if the field exists

getLong

public java.lang.Long getLong(java.lang.String name)

Gets the field value as long.

Parameters:

name - field name

Returns:

the long value of the field

getString

public java.lang.String getString(java.lang.String name)

Gets the field value as string.

Parameters:

name - field name

Returns:

the string value of the field

getStrings

public java.util.List<java.lang.String> getStrings(java.lang.String name)

Gets the field value as string list.

Parameters:

name - field name

getFiles

public java.util.List<FileDto> getFiles(java.lang.String name)

Gets the field value as file list.

Parameters:

name - field name

getUser

public UserDto getUser(java.lang.String name)

Gets the field value as a user object.

Parameters:

name - field name

getUsers

public java.util.List<UserDto> getUsers(java.lang.String name)

Gets the field value as user list.

Parameters:

name - field name

getDateTime

public java.util.Date getDateTime(java.lang.String name)

Gets the field value as a date object.

Parameters:

name - field name

getDate

public java.util.Date getDate(java.lang.String name)

Gets the field value as a date object.

Parameters:

name - field name

getSubtable

public java.util.List<Record> getSubtable(java.lang.String name)

Gets the field value as a sub table.

Parameters:

name - field name

setString

public void setString(java.lang.String name,
                      java.lang.String value)

Adds a new field and sets the string value.

Parameters:

name - field name

value - field value

setLong

public void setLong(java.lang.String name,
                    long value)

Adds a new field and sets the long value.

Parameters:

name - field name

value - field value

setUser

public void setUser(java.lang.String name,
                    java.lang.String code)

Adds a new field and sets the user object.

Parameters:

name - field name

code - field value

setUsers

public void setUsers(java.lang.String name,
                     java.util.List<java.lang.String> codes)

Adds a new field and sets the user object.

Parameters:

name - field name

codes - field value

setFile

public void setFile(java.lang.String name,
                    java.io.File file)

Adds a new field and sets the file object.

Parameters:

name -

file - field value

setFile

public void setFile(java.lang.String name,
                    java.io.File file,
                    java.lang.String contentType)

Adds a new field and sets the file object.

Parameters:

name - field name

file - file object

contentType - content type

setFile

public void setFile(java.lang.String name,
                    java.io.InputStream file,
                    java.lang.String fileName)

Adds a new field and sets the file stream.

Parameters:

name - field name

file - file object

fileName - file name

setFile

public void setFile(java.lang.String name,
                    java.io.InputStream file,
                    java.lang.String fileName,
                    java.lang.String contentType)

Adds a new field and sets the file stream.

Parameters:

name - field name

file - file stream

fileName - file name

contentType - content type

setFiles

public void setFiles(java.lang.String name,
                     java.util.List<java.lang.String> fileKeys)

Adds a new field and sets the file keys.

Parameters:

name - field name

fileKeys - list of the file keys

setStrings

public void setStrings(java.lang.String name,
                       java.util.List<java.lang.String> values)

Adds a new field and sets the string list.

Parameters:

name - field name

values - field value

setDateTime

public void setDateTime(java.lang.String name,
                        java.util.Date date)

Adds a new field and sets the date time value.

Parameters:

name - field name

date - field value

setDate

public void setDate(java.lang.String name,
                    java.util.Date date)

Adds a new field and sets the date value.

Parameters:

name - field name

date - field value

setSubtable

public void setSubtable(java.lang.String name,
                        java.util.List<Record> value)

Adds a new field and sets the sub table.

Parameters:

name - field name

value - field value

getFieldType

public FieldType getFieldType(java.lang.String name)

Gets the field type of the specified field.

Parameters:

name - field name

Returns:

field type