Console Webservice API

DataViewRecord extends DataRecord

Other API in Package

Console

Console System

Internal Console

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 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. 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, 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.

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.

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

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

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

Parameters:

  • String   key

Returns:  String

Since: 08-28-2018

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. 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

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

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

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: 07-11-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, 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

top

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

top

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

top

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

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

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

top

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

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 getValue(String key)

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

Parameters:

  • String   key

Returns:  String

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

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: Nov 22, 2024 11:54 AM