Console Webservice API

DataViewRecord extends DataRecord

Other API in Package

Console

Console System

Internal Console

List of Classes

ConsoleWebServiceController

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

ConsolePacket

ConsoleWebServiceRequest

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

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

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

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

WebServiceResponse

Wizard

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.

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. Changes made are not persisted.

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.

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.

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

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

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: 11-09-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. Changes made are not persisted.

Returns:  Data

Since: 07-11-2008

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

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

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

Data getSystemData(String systemReference)

Returns the information in the SystemDataView. See appendSystem.

Parameters:

  • String   systemReference Required parameter.

Returns:  Data

Since: 11-09-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

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