InternalTransactionController

Action, cp-store-install, supplied by the system when the user has just aquired an item from the store and is now running installer workflow for the first time.

ActionStoreRemove

Action, cp-remove-store, supplied by the system when the user is requesting to be removed from the store and there is a non zero balance on the account.

ActionStoreUpgrade

Action, cp-store-upgrade, supplied by the system when the user has just aquired an upgrade from the store and is now running installer workflow for further configuration

OwnerRole

Indicates the ownership role for the transaction

Method Summary
	clearDebugs() Clears the debug entries.
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.
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.
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.
Buffer	createBuffer() Creates and returns a new Buffer object
Data	createData() Creates and returns an empty Data object
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.
PacketDataList	createDataList(String name, String column, String[] array) Creates a new non persistent PacketDataList and adds the array to the column
PacketDataList	createDataList(String name, String[] columns) Creates a new non persistent PacketDataList and returns it. Maximum column size is 100.
DownloadResponse	createDownloadResponse() Creates a DownloadResponse. This method can only be used in conjunction with the c:download tag.
Email	createEmail(String emailName, String emailSettingsId) Creates an Email container using the specified template and specified enterprise email settings.
Email	createEmail(String name) Creates an Email container using the specified template.
FileBuffer	createFileBuffer(String type, int limit) Creates and returns a new FileBuffer object
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.
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
JSONBuffer	createJsonBuffer() Returns a new JSON Buffer
JSONParser	createJsonParser(String jsonString) Returns a parser for the given JSON string
TextMessage	createMessage() Creates a new Message object.
String	createMobileLink(PalInfo pal, String action, Data data) Creates link for mobile application
Payload	createPayload() Creates a new Payload object.
Payload	createPayload(String json) Creates a new Payload object from the JSON encoded string. See Payload.toJson().
ServiceRequest	createServiceRequest() Creates real-time http(s) request object useful for communication with external web services. Requires activation key with Remote Services enabled.
TextEmail	createTextEmail(String emailName) Creates a text-based (body is text as opposed to XHTML) email.
	debug(Object message) Adds a debug message.
	debugData(Data data) Debugs all the values of the given data object.
	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.
	debugPayload(Payload payload) Debugs the payload. See comments on debugList and debugData
	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.
	dumpDebug() Forces an immediate flush of the debug log. This can be called once every 10 seconds.
	enableDebugger() Over-rides default debugger behavior and explicitely turns on full debug information-- use this in a troubleshooting scenario on a deployed Pal.
	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.
String	enableProfile(String role) Enables the profile for the user identified by role. Returns the new profile ID if successful.
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.
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.
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.
String	getAction() Returns the action.
Browser	getBrowser() Returns a Browser object that contains information about the client browser.
BusinessUtil	getBusinessUtil() Returns a BusinessUtil object.
ChartTool	getChartTool() Creates and returns a chart factory object which can be used to create specific chart types.
DataList	getChildTransactions() Returns a list of all Transactions that were created from this Transaction.
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.
DateUtil	getDateUtil() Returns a utility for working with dates.
EncryptionUtil	getEncryptionUtil() Returns encryption utility
Enterprise	getEnterprise() Returns the enterprise associated with the running Pal.
String	getError() Returns the error, if any.
DataList	getErrors() Returns a list of errors.
Formatter	getFormatter() Returns a formatter.
GeoUtil	getGeoUtil(String units) Returns a utility for working with geo-coordinates. Use km for kilometers and m for miles.
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.
InternalRequest	getInternalRequest() Returns the current internalRequest.
Logger	getLogger() Returns the Logger for this workflow engine.
Monitor	getMonitor() Returns the workflow monitor.
Packet	getPacket() Returns the Packet object associated with this transaction.
Page	getPage(String page) Returns the specified page.
RuntimePal	getPal() Returns the active Pal
RuntimePal	getPalById(String palId) Returns the Pal for the specified palId. Pals must belong to the same enterprise and group.
PalInfo	getPalInfo(String palId) The PalInfo for the specified palId.
String	getParentId() Returns the Transaction ID of this Transaction's parent. Returns null if this Transaction does not have a parent.
String[]	getPlugins() Returns the names of all plugins registered in this cloud
QRUtil	getQRUtil() Returns a utility for creating and reading QR codes.
Request	getRequest() Returns the current Request.
String	getResourcePath(String resource, String version) Returns the resource path for the specified resource.
DataList	getRoles() Returns an modifiable DataList containing role declared by the Pal. The the following columns: role, field1, and field2.
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.
AjaxResponse	getSlice(String sliceId) Returns a response to the client using content from the specified slice. Returns null if no slice is available.
double	getTime() Returns the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC for the given server.
String	getTimeZone() Returns the timezone for this thread.
TransactionUtil	getTransactionUtil() Returns a utility for working with one or more transactions.
User	getUser() Returns the active user.
InternalUser	getUser() Returns the active user.
Validator	getValidator() Returns a utility for validating user data.
String	getWorker() Returns the worker (application server) running this workflow. Useful in a multi-worker environment for analyzing performance and for troubleshooting.
String	getWorkflowName() Returns the name of the currently running workflow.
boolean	isAction(String action) Returns true if the action is the specified action
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.
boolean	isContinue() Returns true if the action is cp-continue. This is the action associated with a link from Console.
boolean	isEndWizard() Returns true if a wizard has just ended and passed control back to the workflow.
boolean	isFileMacrosEnabled() Returns true (default is false) if file macros are enabled.
	redrawConsole() Re-draws the console desktop (currently the left menu). See also InternalUser.switchToProfile.
	removeInlinePal(String palId, String action) Removes the specified inline pal for this session.
	revertWorkflow() Reverts the workflow engine to its prior workflow
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)
	setClean(boolean clean) Sets all dataset operations to clean/not clean. See Dataset.setClean(boolean)
	setDateFormat(String pattern) Sets the date pattern for displaying dates for this thread.
	setErrorPrefix(String errorPrefix) Appends this prefix to any workflow generated error message.
	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).
	setTimeZone(String timezone) Sets the timezone for dates created or displayed in this thread.
	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.
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
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
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.
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.
String	toString() Returns a description of this object.

Method Detail

clearDebugs()

Clears the debug entries.

Since: 07-26-2007

top

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:

Fragment fragment
boolean dynamicRender

Returns: AjaxResponse

Since: 11-19-2008

top

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:

String string
boolean renderJexl

Returns: AjaxResponse

Since: 11-19-2008

top

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:

String userAgent Required parameter.

Returns: Browser

Since: 04-21-2020

top

Buffer createBuffer()

Creates and returns a new Buffer object

Returns: Buffer

Since: 07-11-2008

top

Data createData()

Creates and returns an empty Data object

Returns: Data

Since: 08-21-2007

top

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:

String name
File file

Returns: PacketDataList

Since: 11-19-2009

top

PacketDataList createDataList(String name, String column, String[] array)

Creates a new non persistent PacketDataList and adds the array to the column

Parameters:

String name Required parameter.
String column Required parameter.
String[] array Required parameter.

Returns: PacketDataList

Since: 06-10-2016

top

PacketDataList createDataList(String name, String[] columns)

Creates a new non persistent PacketDataList and returns it. Maximum column size is 100.

Parameters:

String name
String[] columns

Returns: PacketDataList

Since: 10-07-2010

top

DownloadResponse createDownloadResponse()

Creates a DownloadResponse. This method can only be used in conjunction with the c:download tag.

Returns: DownloadResponse

Since: 08-11-2010

top

Email createEmail(String emailName, String emailSettingsId)

Creates an Email container using the specified template and specified enterprise email settings.

Parameters:

String emailName - email template name. Required parameter.
String emailSettingsId - if of enterprise email settings. Required parameter.

Returns: Email

Since: 02-11-2011

top

Email createEmail(String name)

Creates an Email container using the specified template.

Parameters:

String name

Returns: Email

Since: 05-31-2007

top

FileBuffer createFileBuffer(String type, int limit)

Creates and returns a new FileBuffer object

Parameters:

String type Required parameter. Allowed values: zip, jar, ods, odt, xlsx, docx.
int limit - Max size limit in KB, cannot exceed Max Export size of activation key. Required parameter.

Returns: FileBuffer

Since: 08-27-2013

top

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

top

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:

String prefix

Returns: String

Since: 05-21-2009

top

JSONBuffer createJsonBuffer()

Returns a new JSON Buffer

Returns: JSONBuffer

Since: 04-29-2022

top

JSONParser createJsonParser(String jsonString)

Returns a parser for the given JSON string

Parameters:

String jsonString Required parameter.

Returns: JSONParser

Since: 01-29-2016

top

TextMessage createMessage()

Creates a new Message object.

Returns: TextMessage

Since: 04-27-2009

top

String createMobileLink(PalInfo pal, String action, Data data)

Creates link for mobile application

Parameters:

PalInfo pal - Pal to create link to. Required parameter.
String action - action defined in mobile configuration. Required parameter.
Data data - optional data to pass to action.

Returns: String

Since: 06-24-2011

top

Payload createPayload()

Creates a new Payload object.

Returns: Payload

Since: 10-07-2010

top

Payload createPayload(String json)

Creates a new Payload object from the JSON encoded string. See Payload.toJson().

Parameters:

String json Required parameter.

Returns: Payload

Since: 05-16-2011

top

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

top

TextEmail createTextEmail(String emailName)

Creates a text-based (body is text as opposed to XHTML) email.

Parameters:

String emailName

Returns: TextEmail

Since: 05-27-2009

top

debug(Object message)

Adds a debug message.

Parameters:

Object message - Any object.

Since: 06-17-2024

top

debugData(Data data)

Debugs all the values of the given data object.

Parameters:

Data data

Since: 06-04-2019

top

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:

DataList list

Since: 06-21-2019

top

debugPayload(Payload payload)

Debugs the payload. See comments on debugList and debugData

Parameters:

Payload payload

Since: 04-15-2021

top

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:

String message
int length Required parameter. Maximum allowed size of parameter: 150

Since: 07-27-2021

top

dumpDebug()

Forces an immediate flush of the debug log. This can be called once every 10 seconds.

Since: 12-10-2018

top

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

top

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:

boolean enabled

Since: 02-23-2010

top

String enableProfile(String role)

Enables the profile for the user identified by role. Returns the new profile ID if successful.

Parameters:

String role

Returns: String

Since: 01-01-2007

top

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

top

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:

Profile profile
String palId
String action

Returns: WorkflowResponse

Since: 03-30-2009

top

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:

String url
String method Allowed values: get, post.

Returns: WorkflowResponse

Since: 09-12-2008

top

String getAction()

Returns the action.

Returns: String

Since: 05-31-2007

top

Browser getBrowser()

Returns a Browser object that contains information about the client browser.

Returns: Browser

Since: 09-17-2007

top

BusinessUtil getBusinessUtil()

Returns a BusinessUtil object.

Returns: BusinessUtil

Since: 07-15-2009

top

ChartTool getChartTool()

Creates and returns a chart factory object which can be used to create specific chart types.

Returns: ChartTool

Since: 03-01-2018

top

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

top

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

top

DateUtil getDateUtil()

Returns a utility for working with dates.

Returns: DateUtil

Since: 07-29-2008

top

EncryptionUtil getEncryptionUtil()

Returns encryption utility

Returns: EncryptionUtil

Since: 11-30-2016

top

Enterprise getEnterprise()

Returns the enterprise associated with the running Pal.

Returns: Enterprise

Since: 02-17-2011

top

String getError()

Returns the error, if any.

Returns: String

Since: 07-11-2008

top

DataList getErrors()

Returns a list of errors.

Returns: DataList

DataList Name: errors
DataList Fields: error, code, custom

Since: 11-07-2007

top

Formatter getFormatter()

Returns a formatter.

Returns: Formatter

Since: 07-31-2008

top

GeoUtil getGeoUtil(String units)

Returns a utility for working with geo-coordinates. Use km for kilometers and m for miles.

Parameters:

String units Required parameter. Allowed values: km, m.

Returns: GeoUtil

Since: 08-27-2019

top

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

top

InternalRequest getInternalRequest()

Returns the current internalRequest.

Returns: InternalRequest

Since: 08-28-2009

top

Logger getLogger()

Returns the Logger for this workflow engine.

Returns: Logger

Since: 10-19-2020

top

Monitor getMonitor()

Returns the workflow monitor.

Returns: Monitor

Since: 01-04-2010

top

Packet getPacket()

Returns the Packet object associated with this transaction.

Returns: Packet

Since: 05-31-2007

top

Page getPage(String page)

Returns the specified page.

Parameters:

String page

Returns: Page

Since: 05-31-2007

top

RuntimePal getPal()

Returns the active Pal

Returns: RuntimePal

Since: 04-28-2010

top

RuntimePal getPalById(String palId)

Returns the Pal for the specified palId. Pals must belong to the same enterprise and group.

Parameters:

String palId

Returns: RuntimePal

Since: 04-28-2010

top

PalInfo getPalInfo(String palId)

The PalInfo for the specified palId.

Parameters:

String palId

Returns: PalInfo

Since: 10-27-2009

top

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

top

String[] getPlugins()

Returns the names of all plugins registered in this cloud

Returns: String[]

Since: 11-28-2022

top

QRUtil getQRUtil()

Returns a utility for creating and reading QR codes.

Returns: QRUtil

Since: 01-26-2017

top

Request getRequest()

Returns the current Request.

Returns: Request

Since: 05-31-2007

top

String getResourcePath(String resource, String version)

Returns the resource path for the specified resource.

Parameters:

String resource Required parameter.
String version

Returns: String

Since: 12-08-2015

top

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

top

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:

boolean clickOnly

Returns: PacketDataList

DataList Name: types
DataList Fields: type, field1, field2

Since: 01-09-2008

top

AjaxResponse getSlice(String sliceId)

Returns a response to the client using content from the specified slice. Returns null if no slice is available.

Parameters:

String sliceId Required parameter.

Returns: AjaxResponse

Since: 11-23-2022

top

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

top

String getTimeZone()

Returns the timezone for this thread.

Returns: String

Since: 03-14-2022

top

TransactionUtil getTransactionUtil()

Returns a utility for working with one or more transactions.

Returns: TransactionUtil

Since: 11-06-2013

top

User getUser()

Returns the active user.

Returns: User

Since: 08-07-2008

top

InternalUser getUser()

Returns the active user.

Returns: InternalUser

Since: 08-07-2008

top

Validator getValidator()

Returns a utility for validating user data.

Returns: Validator

Since: 07-11-2008

top

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

top

String getWorkflowName()

Returns the name of the currently running workflow.

Returns: String

Since: 11-13-2009

top

boolean isAction(String action)

Returns true if the action is the specified action

Parameters:

String action Required parameter.

Returns: boolean

Since: 05-31-2007

top

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

top

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

top

boolean isEndWizard()

Returns true if a wizard has just ended and passed control back to the workflow.

Returns: boolean

Since: 08-22-2007

top

boolean isFileMacrosEnabled()

Returns true (default is false) if file macros are enabled.

Returns: boolean

Since: 02-23-2010

top

redrawConsole()

Re-draws the console desktop (currently the left menu). See also InternalUser.switchToProfile.

Since: 10-15-2009

top

removeInlinePal(String palId, String action)

Removes the specified inline pal for this session.

Parameters:

String palId Required parameter.
String action Required parameter.

Since: 11-23-2020

top

revertWorkflow()

Reverts the workflow engine to its prior workflow

Since: 05-24-2019

top

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:

String action
int delay

Returns: AjaxResponse

Since: 03-28-2008

top

setClean(boolean clean)

Sets all dataset operations to clean/not clean. See Dataset.setClean(boolean)

Parameters:

boolean clean Required parameter.

Since: 06-15-2022

top

setDateFormat(String pattern)

Sets the date pattern for displaying dates for this thread.

Parameters:

String pattern

Since: 10-07-2021

top

setErrorPrefix(String errorPrefix)

Appends this prefix to any workflow generated error message.

Parameters:

String errorPrefix

Since: 10-05-2015

top

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:

int inactiveTime - time in seconds.

Since: 03-20-2018

top

setTimeZone(String timezone)

Sets the timezone for dates created or displayed in this thread.

Parameters:

String timezone

Since: 10-07-2021

top

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:

String palId Required parameter.
String action Required parameter.
String endpoint Required parameter.
boolean secure Required parameter.

Since: 03-11-2017

top

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:

String palId
String action
Data data
boolean chain

Returns: WorkflowResponse

Since: 12-31-2007

top

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:

String txId
String action
Data data

Returns: WorkflowResponse

Since: 06-20-2008

top

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:

Role user
String action
boolean validateEmail

Returns: WorkflowResponse

Since: 10-22-2009

top

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:

String workflow
String action

Returns: WorkflowResponse

Since: 02-06-2009

top

String toString()

Returns a description of this object.

Returns: String

Since: 06-14-2007

top

API Date: Dec 03, 2024 10:24 AM