doKeep

Copyright © Cloud Software Group, Inc. All Rights Reserved

Chapter 13 TIBCO® General Interface Forms Interface : Interface Properties and Methods : doKeep

doKeep

Purpose

This method closes the form dialog and updates the work item list. (List update is not applicable for case start.)

A custom form class that extends the base class must override this method. The overridden method provides the keep functionality and calls this super class method (using this.jsxsuper();) upon successful completion, as follows:

•

The Keep button on the form triggers the call to the doKeep method.

•

Data is collected from the form.

•

The XML request is obtained using createKeepRequest. This request is then submitted to the Action Processor using socketRequest.

•

The socket results are checked for success, and if successful, calls this super class method (using this.jsxsuper();).

Note that the com.tibco.bpm.ipc.Socket class presents the user with a message dialog if any errors are encountered. The Socket class can be checked for any error conditions using the methods shown in the example below.

Syntax

doKeep()

Parameters

None

Returns

Void

Example

The following is an example usage from com.tibco.bpm.ipc.FormTemplate:

ipcClass.prototype.doKeep = function() {

   var keepRequest = this.createKeepRequest(this.getFormData());

   var socket = this.socketRequest(keepRequest);

   if (socket.isSuccess() && socket.getSsoErrorMsg() == null) {

      this.jsxsuper();

   }

};