Console Webservice API

PacketDataRecord 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
String get(String name)

Gets the value of the specified column referenced by name. Shortcut for getDataValue.
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.
Data getData()

Returns the name/value data of this record. Changes made are 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()
⚠Deprecated since 01-19-2009. See DataViewRecord

Returns this record's Database 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 getValue(int column)

Gets the value of the specified column referenced by index
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.
boolean setData(Data data)

Sets the values in this DataRecord, matching keys in the Data to columns in the record. Returns false if the data object is null.
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 setBoolean(String,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)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.
boolean setDouble(String name, double double)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.
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 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 toString()

Returns a description of this object.

Method Detail

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
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
Data getData()

Returns the name/value data of this record. Changes made are 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 ID.

Returns:  String

Since: 07-11-2008

This method has been deprecated since 01-19-2009. See DataViewRecord

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 getValue(int column)

Gets the value of the specified column referenced by index

Parameters:

  • int   column

Returns:  String

Since: 07-11-2008

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
boolean setData(Data data)

Sets the values in this DataRecord, matching keys in the Data to columns in the record. Returns false if the data object is null.

Parameters:

Returns:  boolean

Since: 07-11-2008

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 setBoolean(String,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)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

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)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

  • String   name
  • double   double

Returns:  boolean

Since: 08-28-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 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 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