This class also used in (click to expand):
AjaxResponse.addPayload(Payload)
AudioFile.readDataLists()
CacheManager.getPayload(String)
CacheManager.putPayload(String, Payload)
Cell.getPayload()
Cell.setPayload(Payload)
Cell.toPayload()
Chunk.addPayload(Payload)
DataList.createSublists(String, int)
DataSet.analyze(boolean)
DataSetRecord.getPayload(String)
DataSetRecord.setPayload(String, Payload)
DataViewList.createSublists(String, int)
DatasetFile.readDataLists()
DisplaySettings.renderSmart(Payload)
Document.getLayerPayload()
Document.setLayerPayload(Payload)
DocumentFile.readDataLists()
DownloadResponse.addPayload(Payload)
Email.addPayload(Payload)
ExcelFile.readDataLists()
File.readDataLists()
Fragment.addPayload(Payload)
ImageFile.readDataLists()
Inspector.getSubjects()
Inspector.ocrAnalyze()
Inspector.ocrExpense()
Inspector.ocrID()
JSONBuffer.setPayload(Payload)
JSONParser.readPayload(String, boolean)
Job.getPayload()
Job.setPayload(Payload)
JobManager.createJob(String, String, Payload)
MailResponse.toPayload()
PWA.createManifest(Payload)
Packet.toPayload()
PacketDataList.createSublists(String, int)
Page.addPayload(Payload)
Page.setSessionLayer(Payload)
PdfFile.getNativeLayer()
PdfFile.readDataLists()
ProfilePacket.getPayload()
Render.addPayload(Payload)
ServiceResponse.getConnectionInfo()
SmartDoc.createEmptyLayer()
SmartDoc.getLayer()
SmartDoc.setLayer(Payload)
StorageProviderDataList.createSublists(String, int)
TextEmail.addPayload(Payload)
TransactionPacket.toPayload()
Tunnel.submit(String, Payload)
Tunnel.submitToken(String, Payload)
TunnelResult.getPayload()
VCardFile.readDataLists()
WebController.createPayload()
WebController.debugPayload(Payload)
|
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.
|
boolean
|
addJavascript(String script)
Adds javascript commands to the payload (assumes the payload will be added to a page or ajax response, otherwise has no meaning). Returns false for illegal or empty script.
|
|
addPayload(Payload payload)
Adds the payload to this response.
|
|
allowHTML(String key)
Permits any rendering target with the specified key to be rendered as HTML.
|
String
|
calcMD5()
Returns an MD5 checksum of the contents of this Payload.
|
String
|
get(String key)
Returns the value associated with key if it exists, null otherwise.
|
Data
|
getData()
Returns the Data object for this response.
|
Data
|
getData(String name)
Returns data object from this payload data maps. Note that changes to data object has no effect on payload. You will need to add data again to update payload
|
PacketDataList
|
getDataList(String name)
Returns data list object from this payload data lists. Note that changes to data list object has no effect on payload. You will need to add data list again to update payload
|
String[]
|
getDataNames()
Returns the names of all Data objects in this Payload.
|
String[]
|
getListNames()
Returns the names of all Lists in this Payload.
|
String
|
getValue(String key)
Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)
|
|
loadJSON(String jsonString)
Decodes the JSON string (presumably a serialized Payload object) and adds its content to this Payload.
|
|
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.
|
|
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.
|
|
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
|
toJSON(String name, boolean compressDataLists)
Returns this Payload object as a JSON encoded string with a root element identified by name.
|
String
|
toJSON(boolean compressDataLists)
Returns this Payload object as a JSON encoded string.
|
String
|
toJson()
Returns this Payload object as a JSON encoded string using web service compatible structure.
|
String
|
toString()
Returns a description of this object.
|
Method Detail
addData(Data data)
Adds the specified Data to this response.
Parameters:
Since:
05-28-2010
boolean addDataList(DataList list)
Adds the specified list to a page
Parameters:
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
boolean addJavascript(String script)
Adds javascript commands to the payload (assumes the payload will be added to a page or ajax response, otherwise has no meaning). Returns false for illegal or empty script.
Parameters:
Returns:
boolean
Since:
07-20-2010
addPayload(Payload payload)
Adds the payload to this response.
Parameters:
Since:
07-20-2010
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
String calcMD5()
Returns an MD5 checksum of the contents of this Payload.
Returns:
String
Since:
05-15-2014
String get(String key)
Returns the value associated with key if it exists, null otherwise.
Parameters:
Returns:
String
Since:
08-28-2018
Data getData()
Returns the Data object for this response.
Returns:
Data
Since:
05-31-2007
Data getData(String name)
Returns data object from this payload data maps. Note that changes to data object has no effect on payload. You will need to add data again to update payload
Parameters:
-
String
name
- name of data in data maps.
Required parameter.
Returns:
Data
Since:
05-19-2011
PacketDataList getDataList(String name)
Returns data list object from this payload data lists. Note that changes to data list object has no effect on payload. You will need to add data list again to update payload
Parameters:
-
String
name
- name of data list in payload.
Required parameter.
Returns:
PacketDataList
Since:
05-19-2011
String[] getDataNames()
Returns the names of all Data objects in this Payload.
Returns:
String[]
Since:
01-06-2015
String[] getListNames()
Returns the names of all Lists in this Payload.
Returns:
String[]
Since:
01-06-2015
String getValue(String key)
Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)
Parameters:
Returns:
String
Since:
07-11-2008
loadJSON(String jsonString)
Decodes the JSON string (presumably a serialized Payload object) and adds its content to this Payload.
Parameters:
-
String
jsonString
Required parameter.
Since:
08-26-2010
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:
Since:
05-28-2010
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:
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
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:
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:
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:
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:
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:
Since:
04-06-2009
This method has been deprecated since 08-28-2018.
Use setInt(String,int)
String toJSON(String name, boolean compressDataLists)
Returns this Payload object as a JSON encoded string with a root element identified by name.
Parameters:
-
String
name
Required parameter.
-
boolean
compressDataLists
Required parameter.
Returns:
String
Since:
01-29-2016
String toJSON(boolean compressDataLists)
Returns this Payload object as a JSON encoded string.
Parameters:
-
boolean
compressDataLists
Required parameter.
Returns:
String
Since:
08-26-2010
String toJson()
Returns this Payload object as a JSON encoded string using web service compatible structure.
Returns:
String
Since:
05-16-2011
String toString()
Returns a description of this object.
Returns:
String
Since:
07-20-2010