|
Method DetailaddData(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:
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:
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:
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:
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 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:
Returns: Boolean Since: 07-11-2008 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:
Returns: Boolean Since: 08-22-2008 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:
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:
Returns: PacketDataList Since: 05-19-2011 String[] getDataNames() Returns the names of all Data objects in this Payload. Returns: String[] Since: 01-06-2015 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:
Returns: Date Since: 07-11-2008 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:
Returns: Boolean Since: 09-05-2008 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:
Returns: Date Since: 09-05-2008 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:
Returns: Double Since: 09-05-2008 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:
Returns: Integer Since: 09-05-2008 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:
Returns: String Since: 09-05-2008 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:
Returns: Double Since: 07-11-2008 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:
Returns: Integer Since: 07-11-2008 String[] getListNames() Returns the names of all Lists in this Payload. Returns: String[] Since: 01-06-2015 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:
Returns: Long Since: 05-28-2022 String getValue(String key) Returns the value associated with key if it exists, null otherwise.
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:
Since: 08-26-2010 removeDataList(String name) Removes the datalist from the payload
Parameters:
Since: 06-29-2021 removeDataMap(String id) Removes the data in the response with the specified id.
Parameters:
Since: 12-21-2017 removeValue(String key) Removes the associated key from the response.
Parameters:
Since: 05-28-2010 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:
Returns: boolean Since: 08-28-2018 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:
Returns: boolean Since: 08-28-2018 boolean setData(String id, Data data) Registers the data in the response with the specified id.
Parameters:
Returns: boolean Since: 02-11-2019 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:
Returns: boolean Since: 08-28-2018 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:
Returns: boolean 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 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:
Returns: boolean Since: 08-28-2018 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:
Returns: boolean Since: 08-28-2018 setValue(String key, Object value) Sets the string value referenced by name. The object must be capable of being serialized as a String.
Parameters:
Since: 07-11-2008 String toJSON(String name, boolean compressDataLists) Returns this Payload object as a JSON encoded string with a root element identified by name.
Parameters:
Returns: String Since: 01-29-2016 String toJSON(boolean compressDataLists) Returns this Payload object as a JSON encoded string.
Parameters:
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 |
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: Nov 18, 2024 01:04 PM |