Request

Method Summary
Request	clean() Returns this request with clean mode enabled which removes all non ASCII characters and any control characters.
	clearSessionData() Deletes all data objects set by setSessionData.
	clearSessionValues() Deletes all values set by setSessionValue.
String	get(String key) Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)
String	getAjaxTarget() If set, returns the ajax-target attribute of the request.
Data	getData() Returns the Data object for this request. This will contain all the form field values posted from the client.
PacketDataList	getDataList(String name, String key, String[] columns, boolean encryptedKey) Returns a data list from the form post.
String	getEncryptedValue(String key) Returns the decrypted value for the specified input field. Returns null if no value exists or if the parameter is not encrypted.
String[]	getEncryptedValues(String key) Returns an array of decrypted values for the specified input field. Returns an empty array if no values exist or if the parameter is not encrypted.
String	getHTML(String name) Returns the html content from the specified input field. Limit 5000 characters. Name limit is 80 characters.
String	getJSON() The JSON payload of an ajax request, if set. See the json parameter of ClientPal.sendAjaxRequest.
String[]	getParameterNames() Returns an array of all parameters sent from the client.
String[]	getParameterValues(String name) Returns an array of all values of the specified parameter.
String	getPin() If access to Navigator was by PIN, this returns the PIN. The PIN is available from this method throughout the life of the Navigator session.
Data	getSessionData(String key) Returns the data stored in the session. Returns null if no data exists with the specified key.
String	getSessionValue(String key) Returns the specified value it it exists.
Upload	getUpload() Returns the Upload object containing user supplied upload content.
Upload	getUpload(String inputFieldName) Returns the Upload object matching input field name.
Upload[]	getUploads() Returns the Upload object(s) containing user supplied upload content.
String	getValue(String key) Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)
String	getXML(String name, String tag, String id) Returns the xhtml content from the specified input field. Tag name to wrap the content with and ID are optional.
boolean	isAjax() Returns true if the request was made from an ajax call.
boolean	isDownload() Returns true if the request was made from the download tag.
boolean	isUploadSizeExceeded() Returns true if total upload size is exceeded, in which case there will be no valid file(s).
	lockWorkflow(String action, String workflow) Locks all requests for the specified action to the given workflow until unlocked for this user's session.
	setSessionData(String key, Data data) Stores the data in the session. Max size allowed is 20K and max entries per session is 50.
	setSessionValue(String key, String value) Sets the specified session value. Use null for the value to remove it from the session.
String	toString() Returns a description of this object.
	unlockWorkflow(String action) Unlocks the action. See lockAction.

Method Detail

---

Request clean()

Returns this request with clean mode enabled which removes all non ASCII characters and any control characters.

Returns:  Request

Since: 12-13-2022

---

clearSessionData()

Deletes all data objects set by setSessionData.

Since: 04-18-2012

---

clearSessionValues()

Deletes all values set by setSessionValue.

Since: 06-18-2020

---

String get(String key)

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

Parameters:

• String   key Required parameter.

Returns:  String

Since: 08-30-2018

---

String getAjaxTarget()

If set, returns the ajax-target attribute of the request.

Returns:  String

Since: 12-20-2017

---

Data getData()

Returns the Data object for this request. This will contain all the form field values posted from the client.

Returns:  Data

Since: 05-31-2007

---

PacketDataList getDataList(String name, String key, String[] columns, boolean encryptedKey)

Returns a data list from the form post.

Parameters:

• String   name
• String   key
• String[]   columns
• boolean   encryptedKey

Returns:  PacketDataList

Since: 05-13-2010

---

String getEncryptedValue(String key)

Returns the decrypted value for the specified input field. Returns null if no value exists or if the parameter is not encrypted.

Parameters:

• String   key

Returns:  String

Since: 09-16-2009

---

String[] getEncryptedValues(String key)

Returns an array of decrypted values for the specified input field. Returns an empty array if no values exist or if the parameter is not encrypted.

Parameters:

• String   key

Returns:  String[]

Since: 09-16-2009

---

String getHTML(String name)

Returns the html content from the specified input field. Limit 5000 characters. Name limit is 80 characters.

Parameters:

• String   name Required parameter. Maximum allowed size of parameter: 80

Returns:  String

Since: 08-09-2010

---

String getJSON()

The JSON payload of an ajax request, if set. See the json parameter of ClientPal.sendAjaxRequest.

Returns:  String

Since: 11-09-2009

---

String[] getParameterNames()

Returns an array of all parameters sent from the client.

Returns:  String[]

Since: 04-28-2009

---

String[] getParameterValues(String name)

Returns an array of all values of the specified parameter.

Parameters:

• String   name

Returns:  String[]

Since: 04-28-2009

---

String getPin()

If access to Navigator was by PIN, this returns the PIN. The PIN is available from this method throughout the life of the Navigator session.

Returns:  String

Since: 11-19-2009

---

Data getSessionData(String key)

Returns the data stored in the session. Returns null if no data exists with the specified key.

Parameters:

• String   key Required parameter.

Returns:  Data

Since: 04-18-2012

---

String getSessionValue(String key)

Returns the specified value it it exists.

Parameters:

• String   key Required parameter.

Returns:  String

Since: 05-31-2007

---

Upload getUpload()

Returns the Upload object containing user supplied upload content.

Returns:  Upload

Since: 05-31-2007

---

Upload getUpload(String inputFieldName)

Returns the Upload object matching input field name.

Parameters:

• String   inputFieldName Required parameter.

Returns:  Upload

Since: 06-29-2011

---

Upload[] getUploads()

Returns the Upload object(s) containing user supplied upload content.

Returns:  Upload[]

Since: 02-02-2011

---

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: 08-09-2007

---

String getXML(String name, String tag, String id)

Returns the xhtml content from the specified input field. Tag name to wrap the content with and ID are optional.

Parameters:

• String   name
• String   tag
• String   id

Returns:  String

Since: 05-12-2009

---

boolean isAjax()

Returns true if the request was made from an ajax call.

Returns:  boolean

Since: 01-10-2009

---

boolean isDownload()

Returns true if the request was made from the download tag.

Returns:  boolean

Since: 11-17-2010

---

boolean isUploadSizeExceeded()

Returns true if total upload size is exceeded, in which case there will be no valid file(s).

Returns:  boolean

Since: 06-29-2011

---

lockWorkflow(String action, String workflow)

Locks all requests for the specified action to the given workflow until unlocked for this user's session.

Parameters:

• String   action Required parameter.
• String   workflow Required parameter.

Since: 09-03-2020

---

setSessionData(String key, Data data)

Stores the data in the session. Max size allowed is 20K and max entries per session is 50.

Parameters:

• String   key Required parameter.
• Data   data  - Pass null to remove from session.

Since: 04-18-2012

---

setSessionValue(String key, String value)

Sets the specified session value. Use null for the value to remove it from the session.

Parameters:

• String   key Required parameter.
• String   value

Since: 05-31-2007

---

String toString()

Returns a description of this object.

Returns:  String

Since: 06-14-2007

---

unlockWorkflow(String action)

Unlocks the action. See lockAction.

Parameters:

• String   action Required parameter.

Since: 09-03-2020