SAP ABAP Class CL_WAPI_WF_TOOLBOX (Actions on Work Item During Execution)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-BMT-WFM (Application Component) SAP Business Workflow
⤷
SWL (Package) Business Workflow: Worklist Client

⤷

⤷

Properties
Class | CL_WAPI_WF_TOOLBOX | |
Short Description | Actions on Work Item During Execution | |
Super Class | ||
Instantiability of a Class | 2 | Public |
Final |
General Data
Message Class | ||
Program status | P | SAP Standard Production Program |
Category | 0 | |
Package | SWL | Business Workflow: Worklist Client |
Created | 19990130 | SAP |
Last change | 20110908 | SAP |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
# | Type group / Object type | Type | Type Description |
---|---|---|---|
1 | ![]() |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
2 | ![]() |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
3 | ![]() |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_WAPI_WF_TOOLBOX has no interface implemented.
Friends
Class CL_WAPI_WF_TOOLBOX has no friend class.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
Constant | Public | Type reference (TYPE) | I | 0 | Small Buttons | 19990130 | |
2 | ![]() |
Constant | Public | Type reference (TYPE) | I | 1 | Big Buttons | 19990130 | |
3 | ![]() |
Constant | Public | Type reference (TYPE) | I | 1 | Enable Forwarding of Work Items | 19990201 | |
4 | ![]() |
Constant | Public | Type reference (TYPE) | I | 4 | Enable Sending of Mails Regarding a Work Item | 19990324 | |
5 | ![]() |
Constant | Public | Type reference (TYPE) | I | 2 | Enable Resubmission of Work Items | 19990201 | |
6 | ![]() |
Constant | Public | Type reference (TYPE) | I | 4 | Show Only a Menu Button Embedded | 19990413 | |
7 | ![]() |
Constant | Public | Type reference (TYPE) | I | 0 | Show Only Toolbar Embedded | 19990201 | |
8 | ![]() |
Constant | Public | Type reference (TYPE) | I | 1 | Show Toolbar and Text and Links Embedded | 19990201 | |
9 | ![]() |
Constant | Public | Type reference (TYPE) | I | 2 | Show Toolbar and Text and Links in Modeless Window | 19990130 | |
10 | ![]() |
Constant | Public | Type reference (TYPE) | I | 1 | Show Separators Between Buttons | 19990325 | |
11 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | I | 0 | Imported Additional Functions | 19990201 | |
12 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | I | 0 | Imported Button Mode | 19990130 | |
13 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Imported Container | 19990130 | ||
14 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | XFLAG | SPACE | Imported commit work permission | 19991206 | |
15 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SY-DYNNR | Calling Screen | 19990130 | ||
16 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | I | 0 | Imported Mode | 19990130 | |
17 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SY-REPID | Calling Program | 19990130 | ||
18 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | I | 0 | Imported Enabling of Separators | 19990325 | |
19 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWW_WIID | Imported Work Item ID | 19990130 | ||
20 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Container in Splitter Lower Area | 19990130 | ||
21 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Container in Splitter Upper Area | 19990130 | ||
22 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_DIALOGBOX_CONTAINER | Container Modeless Dialog | 19990130 | ||
23 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_CUSTOM_CONTAINER | Container for popup dynpro | 20000329 | ||
24 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLTPM_CVI | Log Actions | 19990204 | ||
25 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLTPM_CVI | Log Actions Currently Shown | 19990204 | ||
26 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Log Container Lower Area | 19990130 | ||
27 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Log Container Upper Area | 19990130 | ||
28 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_ALV_GRID | Log Grid | 19990203 | ||
29 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_HTML_VIEWER | Log HTML | 19990204 | ||
30 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWL_TREEIT_T | Log Tree Items | 19990204 | ||
31 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | TREEV_NTAB | Log Tree Nodes | 19990204 | ||
32 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_SPLITTER_CONTAINER | Splitter Control for Workflow Log | 19990130 | ||
33 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLTPM_CVH | Log Steps | 19990204 | ||
34 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_SPLITTER_CONTAINER | Splitter Control | 19990130 | ||
35 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_TOOLBAR | Toolbar Control | 19990130 | ||
36 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_HTML_VIEWER | HTML Control | 19990204 | ||
37 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | I | Indicated if Additional Dialog Open | 19990130 | ||
38 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | CHAR01 | Channel to Enqueue WIM Open? | 20010228 | ||
39 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLOBJECTS_T | Objects Shown in Preview | 19990130 | ||
40 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLTPM_CVI | Actions for Log Grid | 19990204 | ||
41 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLTPMRCVI | Actions Shown in Log Grid | 19990204 | ||
42 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLTPM_OVH | Objects Shown in Log HTML | 19990204 | ||
43 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLTPM_CVH | Steps Shown in Log HTML | 19990204 | ||
44 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWR_MIMEO | Static Var | 19990317 | ||
45 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWL_URL | Static Var | 19990317 | ||
46 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_CTMENU | Static Var | 19990317 | ||
47 | ![]() |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_CTMENU | Static Var | 19990413 | ||
48 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | CHAR01 | Webgui or not Webgui | 20000202 | ||
49 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWWWIHEAD | Work Item Header | 19990130 | ||
50 | ![]() |
Instance attribute | Protected | Type reference (TYPE) | SWLOBJECTS_T | Objects Shown in Preview | 19990204 | ||
51 | ![]() |
Static Attribute | Protected | Type reference (TYPE) | I | 0 | Counter for instances | 19991216 |
Methods
Events
# | Event | Type | Visibility | Description | Created on |
---|---|---|---|---|---|
1 | USER_TOOK_WORKITEM_AWAY | Instance Event (0) |
Public (2) |
You MUST Leave Your Transaction with Cancel (No Commits)! | 19990201 |
Types
Class CL_WAPI_WF_TOOLBOX has no local type.
Method Signatures
Method CLOSE_CRITICAL_METHOD Signature
Method CLOSE_CRITICAL_METHOD on class CL_WAPI_WF_TOOLBOX has no parameter.
Method CLOSE_CRITICAL_METHOD on class CL_WAPI_WF_TOOLBOX has no exception.
Method CONSTRUCTOR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
I_ADD_FUNCTIONS | Value transfer | Type reference (TYPE) | I | 0 | enable additional functions? | 19990201 | |
2 | ![]() |
I_ADD_SEPARATOR | Value transfer | Type reference (TYPE) | I | 0 | show separators between buttons | 19990325 | |
3 | ![]() |
I_BUTTON_STYLE | Value transfer | Type reference (TYPE) | I | 0 | show buttons with texts? | 19990130 | |
4 | ![]() |
I_CONTAINER | Value transfer | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | container for implaced toolbox | 19990130 | ||
5 | ![]() |
I_DO_COMMIT | Value transfer | Type reference (TYPE) | XFLAG | 'X' | allow commit work during toolbox actions | 19991206 | |
6 | ![]() |
I_DYNNR | Value transfer | Type reference (TYPE) | SY-DYNNR | calling screen | 19990130 | ||
7 | ![]() |
I_MODE | Value transfer | Type reference (TYPE) | I | 0 | toolbox mode {small implaced, big implaced; modeless}? | 19990130 | |
8 | ![]() |
I_REPID | Value transfer | Type reference (TYPE) | SY-REPID | calling program | 19990130 | ||
9 | ![]() |
I_WI_ID | Value transfer | Type reference (TYPE) | SWW_WIID | wi | 19990202 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ![]() |
you set mode to implaced, but you didn't import a container | 19990130 | |
2 | ![]() |
could not read workitem | 19990130 | |
3 | ![]() |
no modeless toolbox for webgui | 20000202 | |
4 | ![]() |
only use (add) defined functions (class attributes!) | 19990201 | |
5 | ![]() |
only use defined modes (take class attributes!) | 19990130 |
Method CREATE_SPLITTER Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
E_BOTTOM_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | row 2 | 19990130 | ||
2 | ![]() |
E_SPLITTER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_SPLITTER_CONTAINER | splitter | 19990130 | ||
3 | ![]() |
E_TOP_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | row 1 | 19990130 | ||
4 | ![]() |
I_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | container for spliiter | 19990204 | ||
5 | ![]() |
I_IS_TOOLBAR_SPLITTER | Value transfer | Type reference (TYPE) | I | 1 | manages splitter settings for toolbar | 19990131 |
Method CREATE_SPLITTER on class CL_WAPI_WF_TOOLBOX has no exception.
Method CREATE_TOOLBOX_FUNCTIONS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
ET_BUTTONS | Value transfer | Type reference (TYPE) | SWLC_TB_BUTTONS | table of available buttons | 19990413 |
Method CREATE_TOOLBOX_FUNCTIONS on class CL_WAPI_WF_TOOLBOX has no exception.
Method FREE Signature
Method FREE on class CL_WAPI_WF_TOOLBOX has no parameter.
Method FREE on class CL_WAPI_WF_TOOLBOX has no exception.
Method GET_DYNP_CONTAINER Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
E_DYNP_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CUSTOM_CONTAINER | dynp container | 20000412 |
Method GET_DYNP_CONTAINER on class CL_WAPI_WF_TOOLBOX has no exception.
Method GET_WTB_INSTANCE_COUNT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
RE_WTB_INSTANCE | Value transfer | Type reference (TYPE) | I | eq to WTB_INSTANCE_COUNT | 19991216 |
Method GET_WTB_INSTANCE_COUNT on class CL_WAPI_WF_TOOLBOX has no exception.
Method HANDLER_DIALOG_CLOSE Signature
Method HANDLER_DIALOG_CLOSE on class CL_WAPI_WF_TOOLBOX has no parameter.
Method HANDLER_DIALOG_CLOSE on class CL_WAPI_WF_TOOLBOX has no exception.
Method HANDLER_PROTOCOL_GRID Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
E_COLUMN_ID | Call by reference | Attribute reference (LIKE) | 19990203 | ||||
2 | ![]() |
E_ROW_ID | Call by reference | Attribute reference (LIKE) | 19990203 |
Method HANDLER_PROTOCOL_GRID on class CL_WAPI_WF_TOOLBOX has no exception.
Method HANDLER_PROTOCOL_HTML Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
ACTION | Call by reference | Attribute reference (LIKE) | 19990204 | ||||
2 | ![]() |
FRAME | Call by reference | Attribute reference (LIKE) | 19990204 | ||||
3 | ![]() |
GETDATA | Call by reference | Attribute reference (LIKE) | 19990204 | ||||
4 | ![]() |
POSTDATA | Call by reference | Attribute reference (LIKE) | 19990204 | ||||
5 | ![]() |
QUERY_TABLE | Call by reference | Attribute reference (LIKE) | 19990204 |
Method HANDLER_PROTOCOL_HTML on class CL_WAPI_WF_TOOLBOX has no exception.
Method HANDLER_TOOLBAR_DROPDOWN Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
FCODE | Call by reference | Attribute reference (LIKE) | 19990130 | ||||
2 | ![]() |
POSX | Call by reference | Attribute reference (LIKE) | 19990130 | ||||
3 | ![]() |
POSY | Call by reference | Attribute reference (LIKE) | 19990130 |
Method HANDLER_TOOLBAR_DROPDOWN on class CL_WAPI_WF_TOOLBOX has no exception.
Method HANDLER_TOOLBAR_FUNCTION Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
FCODE | Call by reference | Attribute reference (LIKE) | 19990130 |
Method HANDLER_TOOLBAR_FUNCTION on class CL_WAPI_WF_TOOLBOX has no exception.
Method HANDLER_WORKITEM_HTML Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
ACTION | Call by reference | Attribute reference (LIKE) | 19990204 | ||||
2 | ![]() |
FRAME | Call by reference | Attribute reference (LIKE) | 19990204 | ||||
3 | ![]() |
GETDATA | Call by reference | Attribute reference (LIKE) | 19990204 | ||||
4 | ![]() |
POSTDATA | Call by reference | Attribute reference (LIKE) | 19990204 | ||||
5 | ![]() |
QUERY_TABLE | Call by reference | Attribute reference (LIKE) | 19990204 |
Method HANDLER_WORKITEM_HTML on class CL_WAPI_WF_TOOLBOX has no exception.
Method INITIALIZE Signature
Method INITIALIZE on class CL_WAPI_WF_TOOLBOX has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ![]() |
implaced mode was chosen, but no container was given! | 19990131 | |
2 | ![]() |
could not read workitem | 19990131 | |
3 | ![]() |
webgui cannot handle modeless windows | 20000202 | |
4 | ![]() |
given toolbox mode is not defined | 19990131 |
Method MAINTAIN_DIALOGBOX Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
C_DIALOG | Call by reference | Object reference (TYPE REF TO) | CL_GUI_DIALOGBOX_CONTAINER | dialogbox | 19990201 | ||
2 | ![]() |
I_CAPTION | Call by reference | Type reference (TYPE) | C | caption | 19990201 | ||
3 | ![]() |
I_HEIGHT | Call by reference | Type reference (TYPE) | I | height | 19990201 | ||
4 | ![]() |
I_LEFT | Call by reference | Type reference (TYPE) | I | left | 19990201 | ||
5 | ![]() |
I_TOP | Call by reference | Type reference (TYPE) | I | top | 19990201 | ||
6 | ![]() |
I_WIDTH | Call by reference | Type reference (TYPE) | I | width | 19990201 |
Method MAINTAIN_DIALOGBOX on class CL_WAPI_WF_TOOLBOX has no exception.
Method MAINTAIN_GRID Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
C_GRID | Call by reference | Object reference (TYPE REF TO) | CL_GUI_ALV_GRID | grid | 19990204 | ||
2 | ![]() |
I_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | container for grid | 19990204 | ||
3 | ![]() |
I_STEP | Call by reference | Type reference (TYPE) | SWL_PM_CVH | step of actions to be displayed | 19990204 |
Method MAINTAIN_GRID on class CL_WAPI_WF_TOOLBOX has no exception.
Method MAINTAIN_HTML Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
C_HTML | Call by reference | Object reference (TYPE REF TO) | CL_GUI_HTML_VIEWER | html | 19990204 | ||
2 | ![]() |
I_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | container | 19990130 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ![]() |
could not read workitem | 19990131 |
Method MAINTAIN_PROTOCOL Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
I_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | container for protocol | 19990131 |
Method MAINTAIN_PROTOCOL on class CL_WAPI_WF_TOOLBOX has no exception.
Method MAINTAIN_TOOLBAR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
I_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | container for toolbox | 19990130 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ![]() |
error | 19990130 |
Method OPEN_CRITICAL_METHOD Signature
Method OPEN_CRITICAL_METHOD on class CL_WAPI_WF_TOOLBOX has no parameter.
Method OPEN_CRITICAL_METHOD on class CL_WAPI_WF_TOOLBOX has no exception.
Method REFRESH Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
I_WI_ID | Value transfer | Type reference (TYPE) | SWW_WIID | wi | 19990923 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ![]() |
could not read workitem | 19990131 |
Method START_DYNP Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
I_CONT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Container | 20000329 |
Method START_DYNP on class CL_WAPI_WF_TOOLBOX has no exception.
Event Signatures
Event USER_TOOK_WORKITEM_AWAY Signature
# | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | RAISED_BECAUSE_OF_WHAT | Exporting | Value transfer | Type reference (TYPE) | I | function which led to this event | 19990326 |
History
Last changed by/on | SAP | 20110908 |
SAP Release Created in |