SAP ABAP Class /XNFE/CL_WD_ACTIONS_ASSIST (Basis Assistance Class for WD User Actions)
Hierarchy
☛
SLL-NFE (Software Component) xNFE
⤷
SLL-NFE-MGM (Application Component) NF-e: Communication Management & Monitoring
⤷
/XNFE/USICORE (Package) User Interface of Core Components (NF-e and CT-e)
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | /XNFE/CL_WD_ASSIST_BASIS | Basis Assistance Class for NF-e | 20111222 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | /XNFE/CL_WD_CTE_ACTIONS_ASSIST | (OBSOLETE!) Assistance Class for WD NF-e User Actions | 20120104 |
| 2 | Inheritance (c INHERITING FROM c_ref) | /XNFE/CL_WD_CTE_ACTION_ASSIST | Assistance Class for WD CT-e User Actions | 20130325 |
| 3 | Inheritance (c INHERITING FROM c_ref) | /XNFE/CL_WD_NFE_ACTIONS_ASSIST | (OBSOLETE!) Assistance Class for WD NF-e User Actions | 20120104 |
| 4 | Inheritance (c INHERITING FROM c_ref) | /XNFE/CL_WD_NFE_ACTION_ASSIST | Assistance Class for WD NF-e User Actions | 20130208 |
Properties
| Class | /XNFE/CL_WD_ACTIONS_ASSIST | |
| Short Description | Basis Assistance Class for WD User Actions | |
| Super Class | /XNFE/CL_WD_ASSIST_BASIS | Basis Assistance Class for NF-e |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /XNFE/USICORE | User Interface of Core Components (NF-e and CT-e) |
| Created | 20111109 | SAP |
| Last change | 20141107 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class /XNFE/CL_WD_ACTIONS_ASSIST has no interface implemented.
Friends
Class /XNFE/CL_WD_ACTIONS_ASSIST has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Public | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | General Message Handler for NFE | 20130411 | |||
| 2 | Instance attribute | Protected | Type reference (TYPE) | /XNFE/INHDSTA_T | Status Table | 20120104 | |||
| 3 | Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | Does the action contain unsaved data? | 20111109 | |||
| 4 | Instance attribute | Protected | Type reference (TYPE) | /XNFE/PROC_STEP | Current Process Step | 20111109 | |||
| 5 | Instance attribute | Protected | Type reference (TYPE) | /XNFE/STEPSTAT | Last Step Result | 20120110 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Does the application contain unsaved data? | 20111109 | |
| 2 | Instance method | Public | Method | Check if Triggered Action Can Still Be Executed | 20111109 | |
| 3 | Instance method | Public | Method | Trigger Further Processing of Current Document | 20111109 | |
| 4 | Instance method | Public | Method | Run Database Update | 20111109 | |
| 5 | Instance method | Public | Method | Return Process Type in Which Action Is Executed | 20111109 | |
| 6 | Instance method | Public | Method | Return Currently Processed Step | 20111109 | |
| 7 | Instance method | Public | Method | OBSOLETE: Return GUID of Current Document | 20120104 | |
| 8 | Instance method | Public | Method | Return Status for a Document in a Step | 20120104 | |
| 9 | Instance method | Public | Method | Return the Cached Step Status | 20120110 | |
| 10 | Instance method | Public | Method | Initialize a Step | 20111109 | |
| 11 | Instance method | Protected | Method | Return All Required Data About a Document (Internal) | 20111109 | |
| 12 | Instance method | Private | Method | Trigger Event and Set Appl. for Portal / NWBC Dirty | 20111109 | |
| 13 | Instance method | Public | Method | Set Dirty Flag for Application and NWBC/Portal | 20111109 | |
| 14 | Instance method | Public | Method | Activate or Deactivate Button in the FPM Toolbar | 20111109 | |
| 15 | Instance method | Public | Method | Set Status for Current Process Step | 20120104 |
Events
Class /XNFE/CL_WD_ACTIONS_ASSIST has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_ALV_CONFIG | Protected | See coding | Internal Structure with Reference to ALV Configuration Class | 20111109 | begin of s_alv_config,
name type char30,
alv_config type ref to /xnfe/if_wd_alv_config,
end of s_alv_config
|
|
| 2 | T_ALV_CONFIG | Protected | See coding | Internal Table with Reference to ALV Configuration Class | 20111109 | t_alv_config type standard table of s_alv_config
|
Method Signatures
Method ACTION_IS_DIRTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_DIRTY | Value transfer | Type reference (TYPE) | ABAP_BOOL | Ungesicherte Daten vorhanden? | 20111109 |
Method ACTION_IS_DIRTY on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method CHECK_ACTION_STILL_VALID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20130318 | |||
| 2 | RV_VALID | Value transfer | Type reference (TYPE) | WDY_BOOLEAN | Ersatz für echten boolschen Typ: 'X' == wahr '' == falsch | 20111109 |
Method CHECK_ACTION_STILL_VALID on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method CONTINUE_PROCESSING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20130318 |
Method CONTINUE_PROCESSING on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method DO_DB_UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_WITH_LOCK | Call by reference | Type reference (TYPE) | WDY_BOOLEAN | ABAP_FALSE | Soll Sperre bestehehn bleiben | 20111109 |
Method DO_DB_UPDATE on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method GET_ACTION_PROCESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_PROCTYP | Value transfer | Type reference (TYPE) | /XNFE/PROCTYP | Prozesstyp | 20111109 |
Method GET_ACTION_PROCESS on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method GET_ACTION_STEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_PROCSTEP | Value transfer | Type reference (TYPE) | /XNFE/PROC_STEP | Process Step (ID) | 20111109 |
Method GET_ACTION_STEP on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method GET_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_GUID | Value transfer | Type reference (TYPE) | /XNFE/GUID_16 | Primärschlüssel als GUID im 'RAW' Format | 20120104 |
Method GET_KEY on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method GET_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20130318 | |||
| 2 | IV_RELOAD | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Statusdaten nachlesen | 20120104 | ||
| 3 | RS_STATUS | Value transfer | Type reference (TYPE) | /XNFE/INHDSTA | NFe Incoming Kopfstatus | 20120104 |
Method GET_STATUS on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method GET_STEP_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_STEP_STATUS | Value transfer | Type reference (TYPE) | /XNFE/STEPSTAT | Status des Prozessschrittes | 20120110 |
Method GET_STEP_STATUS on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method INIT_STEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ACTION | Call by reference | Type reference (TYPE) | FPM_EVENT_ID | ID des FPM-Ereignisses | 20111109 |
Method INIT_STEP on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method LOAD_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20130318 | |||
| 2 | IV_WITH_LOCK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Dokument sperren? | 20111109 |
Method LOAD_DATA on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method MARK_DIRTY_FOR_PORTAL Signature
Method MARK_DIRTY_FOR_PORTAL on class /XNFE/CL_WD_ACTIONS_ASSIST has no parameter.
Method MARK_DIRTY_FOR_PORTAL on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method SET_ACTION_DIRTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_DIRTY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Enthält Anwendung ungesicherte Daten? | 20111109 | ||
| 2 | IV_NO_PORTAL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Datenverlustabfrage nicht an NWBC/ Portal weiterleiten | 20111109 |
Method SET_ACTION_DIRTY on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method SET_TOOLBAR_BUTTON_ENABLED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ELEMENT_ID | Call by reference | Type reference (TYPE) | STRING | ID des Buttons | 20111109 | |||
| 2 | IV_ENABLED | Call by reference | Type reference (TYPE) | WDY_BOOLEAN | Aktiv oder Inaktiv | 20111109 | |||
| 3 | IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | FPM Variante, auf der sich der Button befindet | 20111109 |
Method SET_TOOLBAR_BUTTON_ENABLED on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
Method UPDATE_PROCSTEP_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_MSG_HANDLER | Call by reference | Object reference (TYPE REF TO) | /XNFE/CL_NFE_MESSAGES | Allgemeiner Message Handler für NFE | 20130318 | |||
| 2 | IV_LOGHANDLE | Call by reference | Type reference (TYPE) | BALLOGHNDL | Anwendungs-Log: Handle eines Protokolls | 20120104 | |||
| 3 | IV_PARAM | Call by reference | Type reference (TYPE) | DATA | 20120104 | ||||
| 4 | IV_STEPSTAT | Call by reference | Type reference (TYPE) | /XNFE/STEPSTAT | Status des Prozessschrittes | 20120104 |
Method UPDATE_PROCSTEP_STATUS on class /XNFE/CL_WD_ACTIONS_ASSIST has no exception.
History
| Last changed by/on | SAP | 20141107 |
| SAP Release Created in | 900 |