AjaxResponse

Method Summary
	addChart(Chart chart) Adds the specified chart to the response.
	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.
	addDocument(Document document) Adds the specified document to the response for rendering. You must call ClientPal.reloadDocument.
boolean	addFragment(String id, Fragment fragment) Adds the specified fragment to the response. The rendered content is then available on the client, referenced by id. The id must start with a letter and be alphanumeric and cannot be the word 'targets'.
boolean	addJavascript(String script) Adds javascript commands to the page. The commands run in the order added after all CloudPiston code has completed. Returns false if the script is not allowed.
	addPayload(Payload payload) Adds the payload to this response.
boolean	addSlice(String target, String slice) Adds the specified slice to the response if it exists. Returns false if not found
	allowHTML(String key) Permits any rendering target with the specified key to be rendered as HTML.
boolean	checkServer(String action, int delay, String target) Tells the response object to do an AJAX call to the server starting delay seconds after the page loads passing 'action' to the controller and display the results in the element with id 'target'. See Controller.createResponse(Fragment).
String	get(String key) Returns the value associated with key if it exists, null otherwise.
Data	getData() Returns the Data object for this response.
String	getValue(String key) Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)
	removeDataList(String name) Removes the datalist from the payload
	removeDataMap(String id) Removes the data in the response with the specified id.
	removeValue(String key) Removes the associated key from the response.
boolean	resetAjaxUpload(String type, int kilobytes) See resetUpload. This method additionally requires you to provide a client-side javascript function to handle the results of the upload. See the ajax-handler attribute of c:button and c:a.
boolean	resetUpload(String type, int kilobytes) See Page.enableUpload (which must be called initially). Resets file upload and restricts the upload to type and maximum file size. type can be * (all types) or a comma delimited string of types. kilobytes cannot exceed the pal activation settings. Returns false if the user does not have a role assigned.
	set(String key, String value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setBoolean(String name, boolean value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
boolean	setData(String id, Data data) Registers the data in the response with the specified id.
	setDate(String name, Date value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	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.
	setDouble(String name, double double) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	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.
	setInt(String name, long value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setString(String name, String value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setTarget(String target) Changes the ajax-target of this response.
	setValue(String key, String value) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, boolean value) ⚠Deprecated since 08-28-2018. Use setBoolean(String,boolean) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, double value) ⚠Deprecated since 08-28-2018. Use setDouble(String,double) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, int value) ⚠Deprecated since 08-28-2018. Use setInt(String,int) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, long value) ⚠Deprecated since 08-28-2018. Use setInt(String,int) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
String	toString() Returns a description of this object.

Method Detail

---

addChart(Chart chart)

Adds the specified chart to the response.

Parameters:

• Chart   chart

Since: 07-17-2009

---

addData(Data data)

Adds the specified Data to this response.

Parameters:

• Data   data

Since: 05-28-2010

---

boolean addDataList(DataList list)

Adds the specified list to a page

Parameters:

• DataList   list

Returns:  boolean

Since: 07-11-2008

---

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

---

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

---

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

---

addDocument(Document document)

Adds the specified document to the response for rendering. You must call ClientPal.reloadDocument.

Parameters:

• Document   document

Since: 01-09-2009

---

boolean addFragment(String id, Fragment fragment)

Adds the specified fragment to the response. The rendered content is then available on the client, referenced by id. The id must start with a letter and be alphanumeric and cannot be the word 'targets'.

Parameters:

• String   id
• Fragment   fragment

Returns:  boolean

Since: 10-21-2009

---

boolean addJavascript(String script)

Adds javascript commands to the page. The commands run in the order added after all CloudPiston code has completed. Returns false if the script is not allowed.

Parameters:

• String   script

Returns:  boolean

Since: 07-31-2008

---

addPayload(Payload payload)

Adds the payload to this response.

Parameters:

• Payload   payload

Since: 07-20-2010

---

boolean addSlice(String target, String slice)

Adds the specified slice to the response if it exists. Returns false if not found

Parameters:

• String   target Required parameter.
• String   slice Required parameter.

Returns:  boolean

Since: 11-23-2022

---

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

---

boolean checkServer(String action, int delay, String target)

Tells the response object to do an AJAX call to the server starting delay seconds after the page loads passing 'action' to the controller and display the results in the element with id 'target'. See Controller.createResponse(Fragment).

Parameters:

• String   action Required parameter.
• int   delay Required parameter.
• String   target Required parameter.

Returns:  boolean

Since: 12-11-2007

---

String get(String key)

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

Parameters:

• String   key

Returns:  String

Since: 08-28-2018

---

Data getData()

Returns the Data object for this response.

Returns:  Data

Since: 05-31-2007

---

String getValue(String key)

Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)

Parameters:

• String   key

Returns:  String

Since: 07-11-2008

---

removeDataList(String name)

Removes the datalist from the payload

Parameters:

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

Since: 06-29-2021

---

removeDataMap(String id)

Removes the data in the response with the specified id.

Parameters:

• String   id Required parameter.

Since: 12-21-2017

---

removeValue(String key)

Removes the associated key from the response.

Parameters:

• String   key

Since: 05-28-2010

---

boolean resetAjaxUpload(String type, int kilobytes)

See resetUpload. This method additionally requires you to provide a client-side javascript function to handle the results of the upload. See the ajax-handler attribute of c:button and c:a.

Parameters:

• String   type
• int   kilobytes

Returns:  boolean

Since: 10-20-2009

---

boolean resetUpload(String type, int kilobytes)

See Page.enableUpload (which must be called initially). Resets file upload and restricts the upload to type and maximum file size. type can be * (all types) or a comma delimited string of types. kilobytes cannot exceed the pal activation settings. Returns false if the user does not have a role assigned.

Parameters:

• String   type Allowed values: *, har, json, dat, csv, tsv, excel, word, ppoint, pdf, tiff, txt, rtf, jpg, gif, png, ico, calc, writer, impress, xml, html, psd, office, ooffice, image, zip, pal, mp3, 3gpp, vcf, wav, audio, mp4, mov, video, pem, log, cfg, dat, mf, vcf, cnf, qbo, qfx, ofx.
• int   kilobytes

Returns:  boolean

Since: 10-20-2009

---

set(String key, String value)

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

Parameters:

• String   key Required parameter.
• String   value

Since: 08-28-2018

---

setBoolean(String name, boolean value)

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

Parameters:

• String   name Required parameter.
• boolean   value

Since: 08-28-2018

---

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

---

setDate(String name, Date value)

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

Parameters:

• String   name Required parameter.
• Date   value

Since: 08-28-2018

---

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 Required parameter.
• double   value

Since: 08-28-2018

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

---

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 Required parameter.
• double   double

Since: 08-28-2018

---

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

---

setInt(String name, long value)

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

Parameters:

• String   name Required parameter.
• long   value

Since: 08-28-2018

---

setString(String name, String value)

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

Parameters:

• String   name Required parameter.
• String   value

Since: 08-28-2018

---

setTarget(String target)

Changes the ajax-target of this response.

Parameters:

• String   target

Since: 09-17-2009

---

setValue(String key, String value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• String   value

Since: 07-11-2008

---

setValue(String key, boolean value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• boolean   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setBoolean(String,boolean)

---

setValue(String key, double value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• double   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

---

setValue(String key, int value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• int   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

---

setValue(String key, long value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• long   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

---

String toString()

Returns a description of this object.

Returns:  String

Since: 07-11-2008