|
|
Method DetailclearDebugs() Clears the debug entries. Since: 07-26-2007 AjaxResponse createAjaxResponse(Fragment fragment, boolean dynamicRender) Returns a response to the client using content from the fragment. Pass true for dynamicRender to execute business logic tags and JEXL constructs.
Parameters:
Returns: AjaxResponse Since: 11-19-2008 AjaxResponse createAjaxResponse(String string, boolean renderJexl) Returns a response to the client using content from the string. Pass true for renderJexl to execute JEXL constructs.
Parameters:
Returns: AjaxResponse Since: 11-19-2008 Browser createBrowser(String userAgent) Creates a Browser object from the user agent. Some Browser methods may not work when the Browser instance is created this way.
Parameters:
Returns: Browser Since: 04-21-2020 Buffer createBuffer() Creates and returns a new Buffer object Returns: Buffer Since: 07-11-2008 Data createData() Creates and returns an empty Data object Returns: Data Since: 08-21-2007 PacketDataList createDataList(String name, File file) Creates a DataList from the contents of the File. The contents must be CSV or Excel with the first row containing column names.
Parameters:
Returns: PacketDataList Since: 11-19-2009 PacketDataList createDataList(String name, String column, String[] array) Creates a new non persistent PacketDataList and adds the array to the column
Parameters:
Returns: PacketDataList Since: 06-10-2016 PacketDataList createDataList(String name, String[] columns) Creates a new non persistent PacketDataList and returns it. Maximum column size is 100.
Parameters:
Returns: PacketDataList Since: 10-07-2010 DownloadResponse createDownloadResponse() Creates a DownloadResponse. This method can only be used in conjunction with the c:download tag. Returns: DownloadResponse Since: 08-11-2010 Email createEmail(String emailName, String emailSettingsId) Creates an Email container using the specified template and specified enterprise email settings.
Parameters:
Returns: Email Since: 02-11-2011 Email createEmail(String name) Creates an Email container using the specified template.
Parameters:
Returns: Email Since: 05-31-2007 FileBuffer createFileBuffer(String type, int limit) Creates and returns a new FileBuffer object
Parameters:
Returns: FileBuffer Since: 08-27-2013 FtpRequest createFtpRequest() Creates real-time FTP/FTPS/SFTP request object useful for communication with an external FTP service. Requires activation key with Remote Services enabled. Returns: FtpRequest Since: 05-25-2011 String createGUID(String prefix) Creates a Globally Unique ID, alternatively with the specified prefix. Null prefix results in a guid of max length 37. With prefix it is length(prefix)+26
Parameters:
Returns: String Since: 05-21-2009 JSONBuffer createJsonBuffer() Returns a new JSON Buffer Returns: JSONBuffer Since: 04-29-2022 JSONParser createJsonParser(String jsonString) Returns a parser for the given JSON string
Parameters:
Returns: JSONParser Since: 01-29-2016 TextMessage createMessage() Creates a new Message object. Returns: TextMessage Since: 04-27-2009 String createMobileLink(PalInfo pal, String action, Data data) Creates link for mobile application
Parameters:
Returns: String Since: 06-24-2011 Payload createPayload() Creates a new Payload object. Returns: Payload Since: 10-07-2010 Payload createPayload(String json) Creates a new Payload object from the JSON encoded string. See Payload.toJson().
Parameters:
Returns: Payload Since: 05-16-2011 ServiceRequest createServiceRequest() Creates real-time http(s) request object useful for communication with external web services. Requires activation key with Remote Services enabled. Returns: ServiceRequest Since: 11-05-2010 TextEmail createTextEmail(String emailName) Creates a text-based (body is text as opposed to XHTML) email.
Parameters:
Returns: TextEmail Since: 05-27-2009 debug(String message) Adds a debug message.
Parameters:
Since: 09-16-2008 debugData(Data data) Debugs all the values of the given data object.
Parameters:
Since: 06-04-2019 debugList(DataList list) Debugs the name, all of the columns, and up to 100 rows of data. The output is rendered in the debug messages of Pal Builder. This method is used for development purposes and ignored in deployed pals.
Parameters:
Since: 06-21-2019 debugPayload(Payload payload) Debugs the payload. See comments on debugList and debugData
Parameters:
Since: 04-15-2021 debugs(String message, int length) Adds the debug message but splits it into length character segments. Min length is 20 and max is 150. This debugs only to the server-side debugger.
Parameters:
Since: 07-27-2021 boolean deleteConsoleAccess(String profileId, String palId) Deletes access to the specified Console Pal.
Parameters:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 10-04-2013. Use Pal.getConsoleManager().deleteConsoleAccess(profileId) dumpDebug() Forces an immediate flush of the debug log. This can be called once every 10 seconds. Since: 12-10-2018 enableDataSetDebug(boolean enabled) Enables or disables DataSet debugging. See also DataViewList.getQuery()
Parameters:
Since: 02-22-2016 This method has been deprecated since 05-02-2016. Use DataView or DatSet.getQuery(filter) enableDebugger() Over-rides default debugger behavior and explicitely turns on full debug information-- use this in a troubleshooting scenario on a deployed Pal. Since: 07-26-2007 enableFileMacros(boolean enabled) If true, this will over-ride the default file macro checking code provided by the platform and allow uploading and webdav editing of potentially harmful files. This should be used with caution when you trust the upload process. Call this method before calling Page.enableUpload. This setting persists for the entire session of the workflow.
Parameters:
Since: 02-23-2010 ConsoleResponse exitToConsole() Closes Navigator, exits the user to Console. The behavior of this method depends on how the user got to Navigator and whether or not the user has authenticated with ContractPal. Returns: ConsoleResponse Since: 05-31-2007 WorkflowResponse exitToConsolePal(Profile profile, String palId, String action) Closes Navigator, exits the user to the specified ConsolePal and the specified Profile. The user must have rights to run the specified Console Pal or this method will return null. Only allowed for authenticated users.
Parameters:
Returns: WorkflowResponse Since: 03-30-2009 WorkflowResponse exitToWeb(String url, String method) Forces an exit, redirecting the user to the specified url, optionally sending any data set in a Data object associated with this Response object.
Parameters:
Returns: WorkflowResponse Since: 09-12-2008 String getAction() Returns the action. Returns: String Since: 05-31-2007 Browser getBrowser() Returns a Browser object that contains information about the client browser. Returns: Browser Since: 09-17-2007 BusinessUtil getBusinessUtil() Returns a BusinessUtil object. Returns: BusinessUtil Since: 07-15-2009 ChartTool getChartTool() Creates and returns a chart factory object which can be used to create specific chart types. Returns: ChartTool Since: 03-01-2018 DataList getChildTransactions() Returns a list of all Transactions that were created from this Transaction. Returns: DataList DataList Name: transactions DataList Fields: id, name, description, category, status, createDate, createTime Since: 06-20-2008 ConsolePacket getConsolePacket() Returns the ConsolePacket associated with this Console Pal. There exists only one ConsolePacket for each ConsolePal. All users access the same ConsolePacket. Be careful when writing workflow that modifies the ConsolePacket. Typically, setting properties on the ConsolePacket should be limited to initialization, Console System workflow, or an administrator to reduce the chance of collision. If the Pal does not have a console module, this returns null. Returns: ConsolePacket Since: 07-17-2009 DateUtil getDateUtil() Returns a utility for working with dates. Returns: DateUtil Since: 07-29-2008 EncryptionUtil getEncryptionUtil() Returns encryption utility Returns: EncryptionUtil Since: 11-30-2016 Enterprise getEnterprise() Returns the enterprise associated with the running Pal. Returns: Enterprise Since: 02-17-2011 String getError() Returns the error, if any. Returns: String Since: 07-11-2008 DataList getErrors() Returns a list of errors. Returns: DataList DataList Name: errors DataList Fields: error, code, custom Since: 11-07-2007 Formatter getFormatter() Returns a formatter. Returns: Formatter Since: 07-31-2008 GeoUtil getGeoUtil(String units) Returns a utility for working with geo-coordinates. Use km for kilometers and m for miles.
Parameters:
Returns: GeoUtil Since: 08-27-2019 Installer getInstaller() Returns the Installer for this Pal. Think of the Installer as an API version of Pal Manager. A user must have Manage Store permissions on the enterprise. In test mode, you must use a Shadow Pal since Installer manipulation alters the Pal you are working on. Returns: Installer Since: 09-24-2009 Logger getLogger() Returns the Logger for this workflow engine. Returns: Logger Since: 10-19-2020 int getMaxPdfPageCount() Returns the max page count for PDFs. Returns: int Since: 11-05-2013 This method has been deprecated since 10-24-2016. Use Pal.getActivationKeyInfo().getMaxPdfPageCount() Monitor getMonitor() Returns the workflow monitor. Returns: Monitor Since: 01-04-2010 Packet getPacket() Returns the Packet object associated with this transaction. Returns: Packet Since: 05-31-2007 Page getPage(String page) Returns the specified page.
Parameters:
Returns: Page Since: 05-31-2007 RuntimePal getPal() Returns the active Pal Returns: RuntimePal Since: 04-28-2010 RuntimePal getPalById(String palId) Returns the Pal for the specified palId. Pals must belong to the same enterprise and group.
Parameters:
Returns: RuntimePal Since: 04-28-2010 PalInfo getPalInfo(String palId) The PalInfo for the specified palId.
Parameters:
Returns: PalInfo Since: 10-27-2009 SystemDataView getPalViewByGroup(String group) Returns a SystemDataView that can be used for accessing pals of the enterprise that are associated with the specified group. The active user must be a member of the group.
Parameters:
Returns: SystemDataView DataList Name: TxPalsByGroup Tag Support: No
Since: 08-26-2009 This method has been deprecated since 09-19-2017. Use Profile.getPalManager().getPalsByGroup or getTransactionPalsByGroup String getParentId() Returns the Transaction ID of this Transaction's parent. Returns null if this Transaction does not have a parent. Returns: String Since: 06-20-2008 String[] getPlugins() Returns the names of all plugins registered in this cloud Returns: String[] Since: 11-28-2022 QRUtil getQRUtil() Returns a utility for creating and reading QR codes. Returns: QRUtil Since: 01-26-2017 Request getRequest() Returns the current Request. Returns: Request Since: 05-31-2007 String getResourcePath(String resource, String version) Returns the resource path for the specified resource.
Parameters:
Returns: String Since: 12-08-2015 DataList getRoles() Returns an modifiable DataList containing role declared by the Pal. The the following columns: role, field1, and field2. Returns: DataList DataList Name: roles DataList Fields: role, field1, field2 Since: 01-09-2008 PacketDataList getSignatureTypes(boolean clickOnly) Returns an modifiable DataList containing signature types supported for this transaction. The list has three columns: the signature type and two empty columns (field1, and field2). If clickOnly is true, this will return a DataList with a single record. See Page.enableAdHoc. Note: if the activation key does not support audio signing, audio will not be on the list.
Parameters:
Returns: PacketDataList DataList Name: types DataList Fields: type, field1, field2 Since: 01-09-2008 AjaxResponse getSlice(String sliceId) Returns a response to the client using content from the specified slice. Returns null if no slice is available.
Parameters:
Returns: AjaxResponse Since: 11-23-2022 double getTime() Returns the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC for the given server. Returns: double Since: 10-07-2021 String getTimeZone() Returns the timezone for this thread. Returns: String Since: 03-14-2022 TransactionUtil getTransactionUtil() Returns a utility for working with one or more transactions. Returns: TransactionUtil Since: 11-06-2013 User getUser() Returns the active user. Returns: User Since: 05-31-2007 ProfilePacket getUserPacket() Returns the ProfilePacket associated with this Console Pal. Each user of the Console Pal has a single ProfilePacket. If the Pal does not have a console module, this returns null. Also returns null if the user has not been granted console pal access. Returns: ProfilePacket Since: 07-17-2009 This method has been deprecated since 02-03-2014. Use Profile.getUserPacket() Validator getValidator() Returns a utility for validating user data. Returns: Validator Since: 07-11-2008 String getWorker() Returns the worker (application server) running this workflow. Useful in a multi-worker environment for analyzing performance and for troubleshooting. Returns: String Since: 07-05-2021 String getWorkflowName() Returns the name of the currently running workflow. Returns: String Since: 11-13-2009 boolean grantConsoleAccess(String profileId, String palId) Grants access to the specified Console Pal. An icon will appear on the user's desktop. Requires a personal profile or a profile that belongs to the enterprise with sufficient group permissions.
Parameters:
Returns: boolean Since: 03-30-2009 This method has been deprecated since 10-04-2013. Use Pal.getConsoleManager().grantConsoleAccess(profileId) boolean isAction(String action) Returns true if the action is the specified action
Parameters:
Returns: boolean Since: 05-31-2007 boolean isBegin() Returns true if the action is cp-begin. This is the action associated with the Transaction being created by an end user from an external link. Returns: boolean Since: 05-31-2007 boolean isContinue() Returns true if the action is cp-continue. This is the action associated with a link from Console. Returns: boolean Since: 05-31-2007 boolean isEndWizard() Returns true if a wizard has just ended and passed control back to the workflow. Returns: boolean Since: 08-22-2007 boolean isFileMacrosEnabled() Returns true (default is false) if file macros are enabled. Returns: boolean Since: 02-23-2010 boolean isWebDavEnabled() Returns true if webdav support is enabled. Returns: boolean Since: 08-29-2012 This method has been deprecated since 10-11-2016. No replacement. removeInlinePal(String palId, String action) Removes the specified inline pal for this session.
Parameters:
Since: 11-23-2020 revertWorkflow() Reverts the workflow engine to its prior workflow Since: 05-24-2019 AjaxResponse sendAjaxAction(String action, int delay) Creates a response object which triggers the client browser to automatically post the given action. This call can only be used in conjunction with other ajax calls (Response.checkServer and Page.checkServer). Delay can be 0. (AJAX)
Parameters:
Returns: AjaxResponse Since: 03-28-2008 setClean(boolean clean) Sets all dataset operations to clean/not clean. See Dataset.setClean(boolean)
Parameters:
Since: 06-15-2022 setDateFormat(String pattern) Sets the date pattern for displaying dates for this thread.
Parameters:
Since: 10-07-2021 setErrorPrefix(String errorPrefix) Appends this prefix to any workflow generated error message.
Parameters:
Since: 10-05-2015 setMaxInactiveInterval(int inactiveTime) Sets the max inactive time for this user. If no activity occurs in this time, the user will be logged out. Min is 1 second, max is 28800 seconds (8 hours).
Parameters:
Since: 03-20-2018 setTimeZone(String timezone) Sets the timezone for dates created or displayed in this thread.
Parameters:
Since: 10-07-2021 setTimeoutAction(String palId, String action, String endpoint, boolean secure) If the pal has a web pal component, this will tell the platform to take the user to the web workflow of the specified pal when there is a session timeout event. The action will be encrypted and can be obtained from the path of the web pal. If secure=true, the user will be taken to the secure web url of the pal. Throws exception if the pal does not have a web component. This should be called on each page load.
Parameters:
Since: 03-11-2017 setUtilityReference(String reference) Sets the utility billing reference for this thread. This is a development feature.
Parameters:
Since: 04-22-2011 This method has been deprecated since 02-06-2019. No replacement. WorkflowResponse switchToNewTransaction(String palId, String action, Data data, boolean chain) Creates a new Transaction using the specified Pal ID and initiates the workflow with the given action and data. The data is made available to the new Transaction as if it was posted on the request (Controller.getRequest().getData()). After calling this method, you MUST return control back to the system for it to be carried out. This method will throw an exception if the palId is invalid
Parameters:
Returns: WorkflowResponse Since: 12-31-2007 WorkflowResponse switchToTransaction(String txId, String action, Data data) Switches context to the Transaction specified txId and initiates the workflow with the given action and data. The data is made available to the Transaction as if it was posted on the request (Controller.getRequest().getData()). After calling this method, you MUST return control back to the system for it to be carried out. This method will throw an exception if the txId is invalid
Parameters:
Returns: WorkflowResponse Since: 06-20-2008 WorkflowResponse switchToUser(Role user, String action, boolean validateEmail) Forces an exit of the transaction and presents the login screen for the specified user. On successful login, the transaction will resume with the action specified by action. If the user is creating an account as part of this process, validateEmail determines whether to force the user to validate the email as part of the registration process.
Parameters:
Returns: WorkflowResponse Since: 10-22-2009 WorkflowResponse switchToWorkflow(String workflow, String action) Switches the user to a different workflow file. Workflow must be of the same type. You must immediately return this response.
Parameters:
Returns: WorkflowResponse Since: 02-06-2009 String toString() Returns a description of this object. Returns: String Since: 06-14-2007 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: Apr 13, 2024 04:04 PM |