Copyright © Cloud Software Group, Inc. All Rights Reserved

Interface Properties and Methods

This section provides information about the properties and methods available in the com.tibco.bpm.ipc.Form base class. Since the custom form class extends this base class, these properties and methods can be accessed directly in your custom form class.

Base Class Properties

The following accessor methods are available to the subclass to access properties in the com.tibco.bpm.ipc.Form base class.

 

Method	Returns	Property Description
isStartCase()	boolean	True if form opened for a start case.
getDescription()	string	Start case or work item description.
getProcName()	string	The procedure name.
getStepName()	string	Name of the start step.
getProcTag()	string	The procedure tag.
getCaseNumber()	string	The case number.1
getWorkItemTag()	string	The work item tag.a
getWorkQTag()	string	The work queue tag.a
getNode()	jsx3.xml.Entity	The start case or work item node.

---

1

The case number, work item tag, and work queue tag are null for start case.

Note that any of the values in the node returned by getNode() can be read using getAttribute('attributeName') as shown below:

var version = this.getNode().getAttribute('Version');

The following samples show node data returned by getNode() (shown formatted):

For Start Case:

<record

   jsxid="IDAOAICE"

   jsxtext=""

   jsximg=""

   IsStatus="true"

   IsStatusImage="JSXAPPS/ipc/application/images/ProcReleased.gif"

   Name="PROCNAME"

   Description="Case Description"

   HostingNode="serverNodeName"

   Version="0.2"

   Tag="serverNodeName|PROCNAME|0|2"

   ProcNumber="36"

   StartStepName="STEP1"

   Status="swReleased"

   CaseDescOpt="swRequiredDesc"

   IsAutoPurge="false"

   IsIgnoreBlank="false"

   IsNetworked="false"

   IsSubProc="false"

   IsSubProcImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsOrphaned="false"

   IsWorkDays="true"

   IsPrediction="false"

   Owner="username"

   Duration="swDurationNone"

   Permission="Start / History"

   CaseCount="36"

   ActiveCount="35"

   ClosedCount="1"

   jsxselected="1"

   ListId="_jsx_ipcNS_102"

   IsCustomFormStartCase="true">

</record>

 

For Work Item:

<record

   jsxid="IDAFSZGE"

   jsxtext=""

   jsximg=""

   IsStatus="true"

   IsStatusImage="JSXAPPS/ipc/application/images/ItemLockedDesktop.gif"

   CaseNumber="4922"

   CaseReference="36-4922"

   Description="Case Description"

   Tag="serverNodeName|PROCNAME|username|R|4922|421916|
                                         serverNodeName|STEP1|0|2"

   StartedBy="username@serverNodeName"

   Proc_Name="PROCNAME"

   Proc_Description="Proc Description"

   Proc_HostingNode="serverNodeName"

   Version="0.2"

   Proc_Tag="serverNodeName|PROCNAME|0|2"

   ComputerName="OZQUADLING"

   CaseFields=""

   MailId="421916|serverNodeName"

   CaseTag="serverNodeName|PROCNAME|0|2|4922"

   AddrToName="username@serverNodeName"

   Arrived="2006-08-29 16:22"

   IsDeadline="false"

   IsDeadlineImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsDeadlineExp="false"

   IsDeadlineExpImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsKeepOnWithdrawalImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsKeepOnWithdrawal="false"

   IsForwardableImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsForwardable="false"

   IsLocked="false"

   IsLockedImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsLongLocked="true"

   IsLongLockedImage="JSXAPPS/ipc/application/images/IsTrue.gif"

   IsOrphanedImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsOrphaned="false"

   IsReleasable="false"

   IsReleasableImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsUnopened="false"

   IsUnopenedImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsUrgent="false"

   IsUrgentImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   IsSuspended="false"

   IsSuspendedImage="JSXAPPS/ipc/application/images/IsFalse.gif"

   LockedBy="username"

   Priority="50"

   StepName="STEP1"

   StepDescription="First step"

   OCCUPATION=""

   WorkQParam1=""

   WorkQParam2=""

   WorkQParam3=""

   WorkQParam4=""

   DeltaStatus="swNotDeltaItem"

   jsxselected="1"

   ListId="_jsx_ipcNS_254"

   IsCustomFormStartCase="false">

</record>

Base Class Methods

This section provides information about the methods available in the com.tibco.bpm.ipc.Form base class.

Note that at a minimum, the custom class that extends the com.tibco.bpm.ipc.Form base class must override the postLoadInit, doKeep, and doRelease methods; it can also optionally override the init and doCancel methods.

The following is a list of the methods described in this section:

•	buildCDFArrays

•

closeForm

•	confirmUserMessage

•	createFieldDefsRequest

•	createKeepRequest

•	createLockRequest

•	createReleaseRequest

•

doCancel

•

doClose

•

doKeep

•

doRelease

•	getWindowContext

•

init

•	lockWorkItem

•	onBeforeUnload

•	postLoadInit

•	readFieldDefs

•	readFormFields

•	readStepMarkings

•	showUserMessage

•	socketRequest

•	transformData

Copyright © Cloud Software Group, Inc. All Rights Reserved