Console API

Request

List of Classes

ConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

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.

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 isPWA()

Returns true of the request was made from a PWA application.

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

top

clearSessionData()

Deletes all data objects set by setSessionData.

Since: 04-18-2012

top

clearSessionValues()

Deletes all values set by setSessionValue.

Since: 06-18-2020

top

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

top

String getAjaxTarget()

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

Returns:  String

Since: 12-20-2017

top

Data getData()

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

Returns:  Data

Since: 12-31-2008

top

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

top

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

top

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

top

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

top

String getJSON()

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

Returns:  String

Since: 01-25-2010

top

String[] getParameterNames()

Returns an array of all parameters sent from the client.

Returns:  String[]

Since: 04-28-2009

top

String[] getParameterValues(String name)

Returns an array of all values of the specified parameter.

Parameters:

  • String   name

Returns:  String[]

Since: 04-28-2009

top

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

top

String getSessionValue(String key)

Returns the specified value it it exists.

Parameters:

  • String   key Required parameter.

Returns:  String

Since: 12-31-2008

top

Upload getUpload()

Returns the Upload object containing user supplied upload content.

Returns:  Upload

Since: 04-29-2010

top

Upload getUpload(String inputFieldName)

Returns the Upload object matching input field name.

Parameters:

  • String   inputFieldName Required parameter.

Returns:  Upload

Since: 06-29-2011

top

Upload[] getUploads()

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

Returns:  Upload[]

Since: 02-02-2011

top

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: 12-31-2008

top

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

top

boolean isAjax()

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

Returns:  boolean

Since: 02-05-2009

top

boolean isDownload()

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

Returns:  boolean

Since: 11-17-2010

top

boolean isPWA()

Returns true of the request was made from a PWA application.

Returns:  boolean

Since: 10-14-2021

top

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

top

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

top

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

top

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: 12-31-2008

top

String toString()

Returns a description of this object.

Returns:  String

Since: 12-31-2008

top

unlockWorkflow(String action)

Unlocks the action. See lockAction.

Parameters:

  • String   action Required parameter.

Since: 09-03-2020

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 18, 2024 01:04 PM