Transaction API

DataSetRecord extends DataViewRecord

List of Classes

TransactionController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

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 name)

Gets the value of the specified column referenced by name. Shortcut for getDataValue.
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. 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.
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, double 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
int getDefaultInt(String field, int 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 property. If the field does not exist, it returns the default value. If the field exists but its value is empty, this method returns defaultValue only if emptyIsNull=true.
double getDouble(String field)

Returns the given field 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
int getInt(String field)

Returns the given field as an int. Throws exception if the value does not exist or cannot be cast to the correct type.
String getPalId()
⚠Deprecated since 06-26-2015. Use get('CP_PALID') or your own custom column

Returns the pal ID associated with this record
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 getTxId()
⚠Deprecated since 06-26-2015. Use get('CP_TXID') or your own custom column

Returns the transaction ID associated with this record
String getValue(int column)

Gets the value of the specified column referenced by index
boolean isTest()
⚠Deprecated since 03-16-2012. Check Pal.isTestMode

Returns whether or not this is a test record
boolean set(String name, String value)

Sets the string value of the specified column referenced by name. Returns false if the column does not exist.
boolean setBoolean(String name, boolean value)

Sets the boolean value of the specified column referenced by name. Returns false if the column does not exist.
  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 setDataValue(String name, boolean value)
⚠Deprecated since 08-28-2018. Use setBooleanString,boolean)

Sets the value of the specified column referenced by name. Returns false if the column does not exist.
boolean setDataValue(String name, double value)
⚠Deprecated since 08-28-2018. Use setDouble(String,double)

Sets the value of the specified column referenced by name. Returns false if the column does not exist.
boolean setDataValue(String name, int value)
⚠Deprecated since 08-28-2018. Use setInt(String,int)

Sets the value of the specified column referenced by name. Returns false if the column does not exist.
boolean setDataValue(String name, long value)
⚠Deprecated since 08-28-2018. Use setInt(String,int)

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 of the specified column referenced by name. Returns false if the column does not exist.
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 setDecimal(String name, double value)
⚠Deprecated since 08-28-2018. Use setDouble(String,double)

Sets the decimal value of the specified column referenced by name. Returns false if the column does not exist.
boolean setDouble(String name, double double)

Sets the decimal value of the specified column referenced by name. Returns false if the column does not exist.
  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, long value)

Sets the integer value of the specified column referenced by name. Returns false if the column does not exist.
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 of the specified column referenced by name. Returns false if the column does not exist.
boolean setValue(int column, String value)
⚠Deprecated since 08-28-2018. Use setString(String,String) or set(String,String)

Sets the value of the specified column referenced by index. Returns false if the column does not exist.
boolean setValue(int column, boolean value)
⚠Deprecated since 08-28-2018. Use setBoolean(String,boolean)

Sets the value of the specified column referenced by index. Returns false if the column does not exist.
boolean setValue(int column, double value)
⚠Deprecated since 08-28-2018. Use setDouble(String,double)

Sets the value of the specified column referenced by index. Returns false if the column does not exist.
boolean setValue(int column, int value)
⚠Deprecated since 08-28-2018. Use setInt(String,int)

Sets the value of the specified column referenced by index. Returns false if the column does not exist.
boolean setValue(int column, long value)
⚠Deprecated since 08-28-2018. Use setInt(String,int)

Sets the value of the specified column referenced by index. Returns false if the column does not exist.
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

top
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

top
String get(String name)

Gets the value of the specified column referenced by name. Shortcut for getDataValue.

Parameters:

  • String   name

Returns:  String

Since: 01-09-2009

top
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

top
boolean getBoolean(String field)

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

Parameters:

  • String   field

Returns:  boolean

Since: 09-05-2008

top
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

top
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

top
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

top
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

top
String getDataValue(String name)

Gets the value of the specified column referenced by name

Parameters:

  • String   name

Returns:  String

Since: 07-11-2008

top
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: 09-05-2008

top
String getDecryptedValue(String encryptedColumn)

Returns the decrypted value of the encrypted column.

Parameters:

  • String   encryptedColumn

Returns:  String

Since: 01-19-2009

top
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

top
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

top
double getDefaultDouble(String field, double 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
  • double   defaultDouble

Returns:  double

Since: 09-05-2008

top
int getDefaultInt(String field, int 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
  • int   defaultInt

Returns:  int

Since: 09-05-2008

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

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

Parameters:

  • String   field
  • String   defaultValue
  • boolean   emptyIsNull

Returns:  String

Since: 09-05-2008

top
double getDouble(String field)

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

Parameters:

  • String   field

Returns:  double

Since: 09-05-2008

top
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

top
String getId()

Returns this record's database primary key id

Returns:  String

Since: 07-11-2008

top
int getIndex()

Returns this record's index in the DataList

Returns:  int

Since: 07-11-2008

top
int getInt(String field)

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

Parameters:

  • String   field

Returns:  int

Since: 09-05-2008

top
String getPalId()

Returns the pal ID associated with this record

Returns:  String

Since: 07-31-2008

This method has been deprecated since 06-26-2015. Use get('CP_PALID') or your own custom column

top
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

top
Data getSystemData(String systemReference)

Returns the information in the SystemDataView. See appendSystem.

Parameters:

  • String   systemReference Required parameter.

Returns:  Data

Since: 10-26-2010

top
String getTxId()

Returns the transaction ID associated with this record

Returns:  String

Since: 07-31-2008

This method has been deprecated since 06-26-2015. Use get('CP_TXID') or your own custom column

top
String getValue(int column)

Gets the value of the specified column referenced by index

Parameters:

  • int   column

Returns:  String

Since: 07-11-2008

top
boolean isTest()

Returns whether or not this is a test record

Returns:  boolean

Since: 07-31-2008

This method has been deprecated since 03-16-2012. Check Pal.isTestMode

top
boolean set(String name, String value)

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

Parameters:

  • String   name
  • String   value

Returns:  boolean

Since: 08-28-2018

top
boolean setBoolean(String name, boolean value)

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

Parameters:

  • String   name
  • boolean   value

Returns:  boolean

Since: 08-28-2018

top
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

top
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

top
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:

Returns:  boolean

Since: 08-30-2010

top
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

top
boolean setDataValue(String name, boolean value)

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

Parameters:

  • String   name
  • boolean   value

Returns:  boolean

Since: 03-30-2009

This method has been deprecated since 08-28-2018. Use setBooleanString,boolean)

top
boolean setDataValue(String name, double value)

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

Parameters:

  • String   name
  • double   value

Returns:  boolean

Since: 03-30-2009

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

top
boolean setDataValue(String name, int value)

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

Parameters:

  • String   name
  • int   value

Returns:  boolean

Since: 03-30-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

top
boolean setDataValue(String name, long value)

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

Parameters:

  • String   name
  • long   value

Returns:  boolean

Since: 05-19-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

top
boolean setDate(String name, Date value)

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

Parameters:

  • String   name
  • Date   value

Returns:  boolean

Since: 08-28-2018

top
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

top
boolean setDecimal(String name, double value)

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

Parameters:

  • String   name
  • double   value

Returns:  boolean

Since: 08-28-2018

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

top
boolean setDouble(String name, double double)

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

Parameters:

  • String   name
  • double   double

Returns:  boolean

Since: 08-28-2018

top
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

top
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

top
boolean setInt(String name, long value)

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

Parameters:

  • String   name
  • long   value

Returns:  boolean

Since: 08-28-2018

top
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

top
boolean setString(String name, String value)

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

Parameters:

  • String   name
  • String   value

Returns:  boolean

Since: 08-28-2018

top
boolean setValue(int column, String value)

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

Parameters:

  • int   column
  • String   value

Returns:  boolean

Since: 07-11-2008

This method has been deprecated since 08-28-2018. Use setString(String,String) or set(String,String)

top
boolean setValue(int column, boolean value)

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

Parameters:

  • int   column
  • boolean   value

Returns:  boolean

Since: 03-30-2009

This method has been deprecated since 08-28-2018. Use setBoolean(String,boolean)

top
boolean setValue(int column, double value)

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

Parameters:

  • int   column
  • double   value

Returns:  boolean

Since: 03-30-2009

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

top
boolean setValue(int column, int value)

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

Parameters:

  • int   column
  • int   value

Returns:  boolean

Since: 03-30-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

top
boolean setValue(int column, long value)

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

Parameters:

  • int   column
  • long   value

Returns:  boolean

Since: 03-30-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

top
String toJson()

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

Returns:  String

Since: 05-09-2022

top
String toString()

Returns a description of this object.

Returns:  String

Since: 01-19-2009

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM