|
Method Detailboolean 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:
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:
Since: 10-21-2010 String get(String name) Gets the value of the specified column referenced by name. Shortcut for getDataValue.
Parameters:
Returns: String Since: 01-09-2009 String get(String systemReference, String systemColumnName) Returns the column value from the system table. See DataViewBuilder.appendSystem()
Parameters:
Returns: String Since: 10-26-2010 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:
Returns: boolean Since: 09-05-2008 String getCdnUrl(String column, boolean secure) Returns the full CDN url, if any, for the remote file.
Parameters:
Returns: String Since: 02-20-2020 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:
Returns: Data Since: 08-30-2010 PacketDataList getDataList(String column) Returns the JSON serialized content of the specified column as a Data object.
Parameters:
Returns: PacketDataList Since: 08-30-2010 String getDataValue(String name) Gets the value of the specified column referenced by name
Parameters:
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:
Returns: Date Since: 09-05-2008 String getDecryptedValue(String encryptedColumn) Returns the decrypted value of the encrypted column.
Parameters:
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:
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:
Returns: Date Since: 09-05-2008 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:
Returns: double Since: 09-05-2008 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:
Returns: int Since: 09-05-2008 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:
Returns: String Since: 09-05-2008 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:
Returns: double Since: 09-05-2008 DatasetFile getFile(String column) Retrieves file contents from specified dataset column. Returns null of no contents have been set for this record
Parameters:
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 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:
Returns: int Since: 09-05-2008 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 Payload getPayload(String column) Returns the JSON serialized content of the specified column as a Payload object.
Parameters:
Returns: Payload Since: 08-30-2010 Data getSystemData(String systemReference) Returns the information in the SystemDataView. See appendSystem.
Parameters:
Returns: Data Since: 10-26-2010 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 String getValue(int column) Gets the value of the specified column referenced by index
Parameters:
Returns: String Since: 07-11-2008 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 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:
Returns: boolean Since: 08-28-2018 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:
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:
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:
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:
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:
Returns: boolean Since: 07-11-2008 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:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 08-28-2018. Use setBooleanString,boolean) 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:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 08-28-2018. Use setDouble(String,double) 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:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 08-28-2018. Use setInt(String,int) 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:
Returns: boolean Since: 05-19-2009 This method has been deprecated since 08-28-2018. Use setInt(String,int) 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:
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:
Returns: boolean Since: 07-11-2008 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:
Returns: boolean Since: 08-28-2018 This method has been deprecated since 08-28-2018. Use setDouble(String,double) 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:
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:
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:
Since: 10-26-2018 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:
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:
Returns: boolean Since: 08-30-2010 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:
Returns: boolean Since: 08-28-2018 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:
Returns: boolean Since: 07-11-2008 This method has been deprecated since 08-28-2018. Use setString(String,String) or set(String,String) 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:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 08-28-2018. Use setBoolean(String,boolean) 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:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 08-28-2018. Use setDouble(String,double) 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:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 08-28-2018. Use setInt(String,int) 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:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 08-28-2018. Use setInt(String,int) 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 |
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: May 01, 2024 05:15 AM |