DataSetRecord extends DataViewRecord

Method Summary
boolean	appendSystem(SystemDataView systemDataView, String systemReference, String columnAlias) Joins the SystemDataView to this record on columnAlias. Use systemReference in subsequent DataViewRecord.get(String,String) calls to access the SystemDataView columns.
	deleteFile(String column) Deletes file contents from specified dataset column. This operation has immediate effect and cannot be undone
String	get(String key) Returns the value associated with key if it exists, null otherwise.
String	get(String systemReference, String systemColumnName) Returns the column value from the system table. See DataViewBuilder.appendSystem()
Boolean	getBoolean(String field) Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
String	getCdnUrl(String column, Boolean secure) Returns the full CDN url, if any, for the remote file.
Boolean	getCommonBoolean(String field) Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
Data	getData() Returns the name/value data of this record (read only). Additionally contains CP-ID, CP-PALID, and CP-TXID
Data	getData(String column) Returns the JSON serialized content of the specified column as a Data object.
PacketDataList	getDataList(String column) Returns the JSON serialized content of the specified column as a Data object.
String	getDataValue(String name) Gets the value of the specified column referenced by name
Date	getDate(String field) Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
String	getDecryptedValue(String encryptedColumn) Returns the decrypted value of the encrypted column.
Boolean	getDefaultBoolean(String field, Boolean defaultBoolean) Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
Date	getDefaultDate(String field, Date defaultDate) Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
Double	getDefaultDouble(String field, Number defaultDouble) Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
Integer	getDefaultInt(String field, Number defaultInt) Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
String	getDefaultValue(String field, String defaultValue, boolean emptyIsNull) Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
Double	getDouble(String key) Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
DatasetFile	getFile(String column) Retrieves file contents from specified dataset column. Returns null of no contents have been set for this record
String	getId() Returns this record's database primary key id
int	getIndex() Returns this record's index in the DataList
Integer	getInt(String key) Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
Long	getLong(String key) Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
Payload	getPayload(String column) Returns the JSON serialized content of the specified column as a Payload object.
Data	getSystemData(String systemReference) Returns the information in the SystemDataView. See appendSystem.
String	getValue(String key) Returns the value associated with key if it exists, null otherwise.
String	getValue(int column) Gets the value of the specified column referenced by index
boolean	set(String name, Object value) Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
boolean	setBoolean(String name, Boolean value) Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
	setData(Data data) Sets the values in this DataRecord, matching keys in the Data to columns in the record.
boolean	setData(String column, Data data) Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.
boolean	setDataList(String column, DataList list) Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.
boolean	setDataValue(String name, String value) Sets the value of the specified column referenced by name. Returns false if the column does not exist.
boolean	setDate(String name, Date value) Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
boolean	setDateValue(String name, Date value) Sets the value of the specified date column referenced by name. Returns false if the column does not exist.
boolean	setDouble(String name, Number double) Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
	setFile(String column, File file) Sets dataset file contents from provided file. This operation requires subsequent call of DataSet.insertRecord() if this record is new record or DataSet.updateRecord() if this record is existing record to persist
	setFile(String column, String provider, File file) Same as setFile but expects the file column to be remote file. Associates the file with the specified storage provider.
boolean	setInt(String name, Number value) Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
boolean	setPayload(String column, Payload payload) Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.
boolean	setString(String name, String value) Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
	setValue(String key, Object value) Sets the string value referenced by name. The object must be capable of being serialized as a String.
String	toJson() Returns the values of this record as a JSON encoded string.
String	toString() Returns a description of this object.

Method Detail

---

boolean appendSystem(SystemDataView systemDataView, String systemReference, String columnAlias)

Joins the SystemDataView to this record on columnAlias. Use systemReference in subsequent DataViewRecord.get(String,String) calls to access the SystemDataView columns.

Parameters:

• SystemDataView   systemDataView Required parameter.
• String   systemReference Required parameter.
• String   columnAlias Required parameter.

Returns:  boolean

Since: 10-26-2010

---

deleteFile(String column)

Deletes file contents from specified dataset column. This operation has immediate effect and cannot be undone

Parameters:

• String   column  - dataset column name (column should be of type 'File'). Required parameter.

Since: 10-21-2010

---

String get(String key)

Returns the value associated with key if it exists, null otherwise.

Parameters:

• String   key

Returns:  String

Since: 08-28-2018

---

String get(String systemReference, String systemColumnName)

Returns the column value from the system table. See DataViewBuilder.appendSystem()

Parameters:

• String   systemReference
• String   systemColumnName

Returns:  String

Since: 10-26-2010

---

Boolean getBoolean(String field)

Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   field

Returns:  Boolean

Since: 07-11-2008

---

String getCdnUrl(String column, Boolean secure)

Returns the full CDN url, if any, for the remote file.

Parameters:

• String   column Required parameter.
• Boolean   secure  - if true, this will return the https:// url, otherwise the http version..

Returns:  String

Since: 02-20-2020

---

Boolean getCommonBoolean(String field)

Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   field

Returns:  Boolean

Since: 08-22-2008

---

Data getData()

Returns the name/value data of this record (read only). Additionally contains CP-ID, CP-PALID, and CP-TXID

Returns:  Data

Since: 07-11-2008

---

Data getData(String column)

Returns the JSON serialized content of the specified column as a Data object.

Parameters:

• String   column

Returns:  Data

Since: 08-30-2010

---

PacketDataList getDataList(String column)

Returns the JSON serialized content of the specified column as a Data object.

Parameters:

• String   column

Returns:  PacketDataList

Since: 08-30-2010

---

String getDataValue(String name)

Gets the value of the specified column referenced by name

Parameters:

• String   name

Returns:  String

Since: 07-11-2008

---

Date getDate(String field)

Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   field

Returns:  Date

Since: 07-11-2008

---

String getDecryptedValue(String encryptedColumn)

Returns the decrypted value of the encrypted column.

Parameters:

• String   encryptedColumn

Returns:  String

Since: 01-19-2009

---

Boolean getDefaultBoolean(String field, Boolean defaultBoolean)

Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value

Parameters:

• String   field
• Boolean   defaultBoolean

Returns:  Boolean

Since: 09-05-2008

---

Date getDefaultDate(String field, Date defaultDate)

Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value

Parameters:

• String   field
• Date   defaultDate

Returns:  Date

Since: 09-05-2008

---

Double getDefaultDouble(String field, Number defaultDouble)

Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value

Parameters:

• String   field
• Number   defaultDouble

Returns:  Double

Since: 09-05-2008

---

Integer getDefaultInt(String field, Number defaultInt)

Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value

Parameters:

• String   field
• Number   defaultInt

Returns:  Integer

Since: 09-05-2008

---

String getDefaultValue(String field, String defaultValue, boolean emptyIsNull)

Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.

Parameters:

• String   field
• String   defaultValue
• boolean   emptyIsNull

Returns:  String

Since: 09-05-2008

---

Double getDouble(String key)

Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   key Required parameter.

Returns:  Double

Since: 07-11-2008

---

DatasetFile getFile(String column)

Retrieves file contents from specified dataset column. Returns null of no contents have been set for this record

Parameters:

• String   column  - dataset column name (column should be of type 'File'). Required parameter.

Returns:  DatasetFile

Since: 10-21-2010

---

String getId()

Returns this record's database primary key id

Returns:  String

Since: 07-11-2008

---

int getIndex()

Returns this record's index in the DataList

Returns:  int

Since: 07-11-2008

---

Integer getInt(String key)

Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   key Required parameter.

Returns:  Integer

Since: 07-11-2008

---

Long getLong(String key)

Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   key Required parameter.

Returns:  Long

Since: 05-28-2022

---

Payload getPayload(String column)

Returns the JSON serialized content of the specified column as a Payload object.

Parameters:

• String   column

Returns:  Payload

Since: 08-30-2010

---

Data getSystemData(String systemReference)

Returns the information in the SystemDataView. See appendSystem.

Parameters:

• String   systemReference Required parameter.

Returns:  Data

Since: 10-26-2010

---

String getValue(String key)

Returns the value associated with key if it exists, null otherwise.

Parameters:

• String   key

Returns:  String

Since: 07-11-2008

---

String getValue(int column)

Gets the value of the specified column referenced by index

Parameters:

• int   column

Returns:  String

Since: 07-11-2008

---

boolean set(String name, Object value)

Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.

Parameters:

• String   name
• Object   value

Returns:  boolean

Since: 08-28-2018

---

boolean setBoolean(String name, Boolean value)

Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• Boolean   value

Returns:  boolean

Since: 08-28-2018

---

setData(Data data)

Sets the values in this DataRecord, matching keys in the Data to columns in the record.

Parameters:

• Data   data Required parameter.

Since: 07-11-2008

---

boolean setData(String column, Data data)

Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.

Parameters:

• String   column
• Data   data

Returns:  boolean

Since: 08-30-2010

---

boolean setDataList(String column, DataList list)

Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.

Parameters:

• String   column
• DataList   list

Returns:  boolean

Since: 08-30-2010

---

boolean setDataValue(String name, String value)

Sets the value of the specified column referenced by name. Returns false if the column does not exist.

Parameters:

• String   name
• String   value

Returns:  boolean

Since: 07-11-2008

---

boolean setDate(String name, Date value)

Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• Date   value

Returns:  boolean

Since: 08-28-2018

---

boolean setDateValue(String name, Date value)

Sets the value of the specified date column referenced by name. Returns false if the column does not exist.

Parameters:

• String   name
• Date   value

Returns:  boolean

Since: 07-11-2008

---

boolean setDouble(String name, Number double)

Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• Number   double

Returns:  boolean

Since: 08-28-2018

---

setFile(String column, File file)

Sets dataset file contents from provided file. This operation requires subsequent call of DataSet.insertRecord() if this record is new record or DataSet.updateRecord() if this record is existing record to persist

Parameters:

• String   column  - dataset column name (column should be of type 'File'). Required parameter.
• File   file  - file with contents. Required parameter.

Since: 10-21-2010

---

setFile(String column, String provider, File file)

Same as setFile but expects the file column to be remote file. Associates the file with the specified storage provider.

Parameters:

• String   column  - dataset column name (column should be of type 'File'). Required parameter.
• String   provider  - provider name or CDN GUID. Required parameter.
• File   file  - file with contents. Required parameter.

Since: 10-26-2018

---

boolean setInt(String name, Number value)

Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• Number   value

Returns:  boolean

Since: 08-28-2018

---

boolean setPayload(String column, Payload payload)

Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.

Parameters:

• String   column
• Payload   payload

Returns:  boolean

Since: 08-30-2010

---

boolean setString(String name, String value)

Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• String   value

Returns:  boolean

Since: 08-28-2018

---

setValue(String key, Object value)

Sets the string value referenced by name. The object must be capable of being serialized as a String.

Parameters:

• String   key
• Object   value

Since: 07-11-2008

---

String toJson()

Returns the values of this record as a JSON encoded string.

Returns:  String

Since: 05-09-2022

---

String toString()

Returns a description of this object.

Returns:  String

Since: 01-19-2009