Web API

Page

Other API in Package

User

Internal Tunnel

Internal Web

Tunnel

Method Summary
  addChartToPage(Chart chart)

Adds the specified chart to the page.

  addData(Data data)

Adds the specified Data to this response.

boolean addDataList(DataList list)

Adds the specified list to a page

boolean addDataMap(String id, Data data)

Registers the data in the response with the specified id.

boolean addDataMaps(String keyColumn, DataList list)

Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.

boolean addDataRecord(String id, DataRecord dataRecord)

Registers the DataRecord in the response with the specified id. Limited to 500 records per response.

  addJavascript(String script)

Adds javascript commands to the page.

  addPayload(Payload payload)

Adds the payload to this response.

  addResponseHeader(String name, String value)

Adds an http response header.

  allowHTML(String key)

Permits any rendering target with the specified key to be rendered as HTML.

  enablePageForm(boolean enabled)

If true, the platform page form will be the root level form on the page and ClientPal.getPageForm() will return it. The default is false, letting the developer control the main page form or forms.

  flushBase(boolean flush)

If set, the base tag will include a version key that forces the browser to reload any cached content on each request. This works best for web sites that have a flat structure (no sub directories).

String get(String key)

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

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.

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 Data object for this response.

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.

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.

String getValue(String key)

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

  removeDataList(String name)

Removes the datalist from the payload

  removeDataMap(String id)

Removes the data in the response with the specified id.

  removeSessionLayer()

Removes the rendering layer, if any.

  removeValue(String key)

Removes the associated key from the response.

boolean set(String name, Object value)

Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.

boolean setBoolean(String name, Boolean value)

Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

boolean setData(String id, Data data)

Registers the data in the response with the specified id.

boolean setDate(String name, Date value)

Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

boolean setDouble(String name, Number double)

Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

  setHTML(String key, String xhtml)

Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.

boolean setInt(String name, Number value)

Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

  setSessionLayer(Payload payload)

Sets a rendering layer based on content stored in the payload. Supported files: images, css, script.

boolean setString(String name, String value)

Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

  setValue(String key, Object value)

Sets the string value referenced by name. The object must be capable of being serialized as a String.

PdfFile toPdf(String fileName)

Creates PDF file from this page. File will reflect current page state. Further modifications of page will not have effect on file contents.

String toString()

Returns a description of this object.

Method Detail


addChartToPage(Chart chart)

Adds the specified chart to the page.

Parameters:

Since: 09-08-2008

top

addData(Data data)

Adds the specified Data to this response.

Parameters:

Since: 05-28-2010

top

boolean addDataList(DataList list)

Adds the specified list to a page

Parameters:

Returns:  boolean

Since: 07-11-2008

top

boolean addDataMap(String id, Data data)

Registers the data in the response with the specified id.

Parameters:

  • String   id Required parameter.
  • Data   data Required parameter.

Returns:  boolean

Since: 05-28-2010

top

boolean addDataMaps(String keyColumn, DataList list)

Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.

Parameters:

  • String   keyColumn Required parameter.
  • DataList   list Required parameter.

Returns:  boolean

Since: 05-28-2010

top

boolean addDataRecord(String id, DataRecord dataRecord)

Registers the DataRecord in the response with the specified id. Limited to 500 records per response.

Parameters:

  • String   id Required parameter.
  • DataRecord   dataRecord Required parameter.

Returns:  boolean

Since: 11-09-2010

top

addJavascript(String script)

Adds javascript commands to the page.

Parameters:

  • String   script

Since: 09-23-2019

top

addPayload(Payload payload)

Adds the payload to this response.

Parameters:

Since: 07-20-2010

top

addResponseHeader(String name, String value)

Adds an http response header.

Parameters:

  • String   name
  • String   value

Since: 05-26-2023

top

allowHTML(String key)

Permits any rendering target with the specified key to be rendered as HTML.

Parameters:

  • String   key Required parameter.

Since: 08-02-2017

top

enablePageForm(boolean enabled)

If true, the platform page form will be the root level form on the page and ClientPal.getPageForm() will return it. The default is false, letting the developer control the main page form or forms.

Parameters:

  • boolean   enabled Required parameter.

Since: 01-06-2022

top

flushBase(boolean flush)

If set, the base tag will include a version key that forces the browser to reload any cached content on each request. This works best for web sites that have a flat structure (no sub directories).

Parameters:

  • boolean   flush

Since: 03-23-2018

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

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

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 Data object for this response.

Returns:  Data

Since: 05-31-2007

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

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

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

removeDataList(String name)

Removes the datalist from the payload

Parameters:

  • String   name  - name of data list in payload. Required parameter.

Since: 06-29-2021

top

removeDataMap(String id)

Removes the data in the response with the specified id.

Parameters:

  • String   id Required parameter.

Since: 12-21-2017

top

removeSessionLayer()

Removes the rendering layer, if any.

Since: 12-08-2017

top

removeValue(String key)

Removes the associated key from the response.

Parameters:

  • String   key

Since: 05-28-2010

top

boolean set(String name, Object value)

Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.

Parameters:

  • String   name
  • Object   value

Returns:  boolean

Since: 08-28-2018

top

boolean setBoolean(String name, Boolean value)

Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

  • String   name
  • Boolean   value

Returns:  boolean

Since: 08-28-2018

top

boolean setData(String id, Data data)

Registers the data in the response with the specified id.

Parameters:

  • String   id Required parameter.
  • Data   data Required parameter.

Returns:  boolean

Since: 02-11-2019

top

boolean setDate(String name, Date value)

Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

  • String   name
  • Date   value

Returns:  boolean

Since: 08-28-2018

top

boolean setDouble(String name, Number double)

Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

  • String   name
  • Number   double

Returns:  boolean

Since: 08-28-2018

top

setHTML(String key, String xhtml)

Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.

Parameters:

  • String   key
  • String   xhtml

Since: 07-11-2008

top

boolean setInt(String name, Number value)

Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

  • String   name
  • Number   value

Returns:  boolean

Since: 08-28-2018

top

setSessionLayer(Payload payload)

Sets a rendering layer based on content stored in the payload. Supported files: images, css, script.

Parameters:

  • Payload   payload Required parameter.

Since: 12-08-2017

top

boolean setString(String name, String value)

Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

  • String   name
  • String   value

Returns:  boolean

Since: 08-28-2018

top

setValue(String key, Object value)

Sets the string value referenced by name. The object must be capable of being serialized as a String.

Parameters:

  • String   key
  • Object   value

Since: 07-11-2008

top

PdfFile toPdf(String fileName)

Creates PDF file from this page. File will reflect current page state. Further modifications of page will not have effect on file contents.

Parameters:

  • String   fileName  - file name. Required parameter.

Returns:  PdfFile

Since: 11-03-2010

top

String toString()

Returns a description of this object.

Returns:  String

Since: 07-11-2008

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM