The com_ibm_bpm_global
object provides
access to functions that are globally available.
Properties
Through the com_ibm_bpm_global
object,
you can access its properties.
Property |
Description |
com_ibm_bpm_global.topLevelCoachViews (Object) |
Lists the top-level Coach View instances in
the current window object. Top-level Coach Views contain a hierarchy
of other Coach Views. The list does not contain the children of these top-level
Coach Views. |
Functions
Through the com_ibm_bpm_global
object,
you can access its functions.
Function |
Description |
com_ibm_bpm_global.coachView.byControlId(controlIds) |
Returns the identified Coach View instance or
null.
- controlIds
(Array) . Lists
the control or view IDs of the Coach Views in the path from the top-level
Coach View to the specified child Coach View.
For example, ViewA is the top-level Coach
View and it contains two other Coach Views in the following hierarchy: ViewA //Control ID is id_ViewA
ViewB //(list) Control ID is id_ViewB
ContentBox
ViewC //Control ID is id_ViewC)
The following table lists examples of what this API returns
for a particular value of controlIds:
Value of controlIds |
Return |
Comment |
["id_ViewA"] |
Instance of ViewA |
|
["id_ViewA", "id_ViewB"] |
Instance of ViewB |
|
["id_ViewA", "id_ViewB", "id_ViewC"] |
First instance of ViewC or
null if the list bound to ViewB is empty |
|
["id_ViewB"] |
Null |
The input parameter does not start with the
ID of the top-level Coach View (id_ViewA ) |
["id_ViewA", "id_ViewC"] |
Null |
The input parameter does not contain the ID
of ViewB , which is in the path to ViewC . |
|
com_ibm_bpm_global.coachView.byDomId(domId) |
Returns the identified Coach View instance or
null.
- domId
(String) . The DOM
ID for the Coach View.
|
com_ibm_bpm_global.getHSFrame() |
Returns the window object in which the human service runs, or
null if the human service does not run in a frame. |