SAP ABAP Class CL_STRUCTURED_ALV (Structured Application Log)
Hierarchy
☛
BBPCRM (Software Component) BBPCRM
⤷
CA-GTF-CSC (Application Component) Country-Specific Objects
⤷
ID-FI (Package) International development: FI-GL/AP/AR
⤷
⤷
Properties
| Class | CL_STRUCTURED_ALV | |
| Short Description | Structured Application Log | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ID-FI | International development: FI-GL/AP/AR |
| Created | 20060918 | SAP |
| Last change | 20100310 | 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) |
Interfaces
Class CL_STRUCTURED_ALV has no interface implemented.
Friends
Class CL_STRUCTURED_ALV has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | See coding | 20060918 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Private | Method | Adds a node to the ALV tree | 20060918 | |
| 2 | Static method | Private | Method | Display the content of the structure typed fields | 20060918 | |
| 3 | Static method | Private | Method | Displays the content of the table typed fields | 20060918 | |
| 4 | Static method | Public | Method | Appends the Field Catalog table | 20060918 | |
| 5 | Static method | Private | Method | Checks object types of the include are filled or not | 20080813 | |
| 6 | Static method | Public | Method | Displays the contents of the forms | 20060918 | |
| 7 | Static method | Private | Method | Creates a category for the node | 20060918 | |
| 8 | Static method | Private | Method | Displays the content of one form | 20060918 | |
| 9 | Static method | Private | Method | Reads the Dictionary sources of a table | 20060918 |
Events
Class CL_STRUCTURED_ALV has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | CY_FIELDCAT | Private | See coding | 20060918 | BEGIN OF cy_fieldcat,
field_name TYPE char30,
fieldcatalog TYPE slis_t_fieldcat_alv,
END OF cy_fieldcat
|
Method Signatures
Method ALV_ADD_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_NODE_KEY | Call by reference | Type reference (TYPE) | BALS_NODE_KEY | Structured Application Log | 20060918 | |||
| 2 | IV_CATEGORY | Call by reference | Type reference (TYPE) | BALS_CATEG_ID | Structured Application Log: Category ID | 20060918 | |||
| 3 | IV_NODE_TEXT | Call by reference | Type reference (TYPE) | BALS_NODE_TXT | Structured Application Log: Node Text | 20060918 | |||
| 4 | IV_RELATKEY | Call by reference | Type reference (TYPE) | BALS_NODE_KEY | Structured Application Log | 20060918 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Program error | 20060918 |
Method ALV_ADD_STRUCTURE_TO_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_LINES_PROCESSED | Call by reference | Type reference (TYPE) | I | Number of Processed Lines | 20061026 | |||
| 2 | IS_CONTENT | Call by reference | Type reference (TYPE) | ANY | 20060918 | ||||
| 3 | IT_OUTPUT_FIELDS | Call by reference | Type reference (TYPE) | BALS_T_DD03P | Fields of the DDIC Structure | 20070313 | |||
| 4 | IV_FIELD | Call by reference | Type reference (TYPE) | FIELDNAME | For form structure field's name | 20060918 | |||
| 5 | IV_NODE_KEY | Call by reference | Type reference (TYPE) | BALS_NODE_KEY | HR Application Log | 20060918 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error occurred while assigning field-symbol | 20060918 | ||
| 2 | Structure was not found in DDIC | 20060918 |
Method ALV_ADD_TABLE_TO_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_NODE_KEY | Call by reference | Type reference (TYPE) | BALS_NODE_KEY | Structured Application Log | 20060918 | |||
| 2 | IS_FORM_CONTENT | Call by reference | Type reference (TYPE) | ANY | Content to be displayed in table | 20060918 | |||
| 3 | IV_FIELD | Call by reference | Type reference (TYPE) | FIELDNAME | Structure field's name to be displayed | 20060918 | |||
| 4 | IV_MODE | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20060918 | |||
| 5 | IV_ROWTYPE | Call by reference | Type reference (TYPE) | CHAR30 | 30 Characters | 20060918 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error occurred while assigning field-symbol | 20060918 | ||
| 2 | Error occurred while displaying table | 20060918 |
Method ALV_APPEND_FIELD_CATALOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_FIELDCATALOG | Call by reference | Type reference (TYPE) | SLIS_T_FIELDCAT_ALV | Field Catalog | 20060918 | |||
| 2 | IV_SECTION_NAME | Call by reference | Type reference (TYPE) | CHAR30 | For form structure field's name | 20060918 |
Method ALV_APPEND_FIELD_CATALOG on class CL_STRUCTURED_ALV has no exception.
Method ALV_CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EC_EMPTY | Call by reference | Type reference (TYPE) | CHAR_01 | Character length 1 | 20080813 | |||
| 2 | IS_CONTENT | Call by reference | Type reference (TYPE) | ANY | 20080813 | ||||
| 3 | IT_EXCLUDED_FIELDS | Call by reference | Type reference (TYPE) | J_3R_EXCLUDED_FIELDS_TAB | Table of Excluded Fields of Single Data Structures | 20080813 | |||
| 4 | I_ADMINFIELD | Call by reference | Type reference (TYPE) | CHAR_01 | Character length 1 | 20080813 | |||
| 5 | I_ALV_TEXT | Call by reference | Type reference (TYPE) | CHAR200 | Text field length 200 | 20080813 | |||
| 6 | I_DD03P | Call by reference | Type reference (TYPE) | ANY TABLE | 20080813 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Structure was not found in the DDIC | 20080813 |
Method ALV_CONTENT_DISPLAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_RETCODE | Call by reference | Type reference (TYPE) | CHAR10 | Return Code of ALV Button | 20061026 | |||
| 2 | IS_DISPLAY_PROFILE | Call by reference | Type reference (TYPE) | BALS_S_DISP_PROF | Display Profile of ALV | 20060918 | |||
| 3 | IT_CONTENT | Call by reference | Type reference (TYPE) | ANY TABLE | Content to be displayed in a table | 20060918 | |||
| 4 | IT_EXCLUDED_FIELDS | Call by reference | Type reference (TYPE) | J_3R_EXCLUDED_FIELDS_TAB | Table of Excluded Fields of Single Data Structures | 20060918 | |||
| 5 | IV_STRUCTURE_NAME | Call by reference | Type reference (TYPE) | CHAR30 | Line type of the contents | 20060918 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Program error | 20060918 |
Method ALV_CREATE_CATEGORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_FIELDCAT | Call by reference | Type reference (TYPE) | SLIS_T_FIELDCAT_ALV | Field Catalog | 20060918 | |||
| 2 | IV_CATEGORY | Call by reference | Type reference (TYPE) | BALS_CATEG_ID | Structured Application Log: Category ID | 20060918 | |||
| 3 | IV_STRUCTURE_NAME | Call by reference | Type reference (TYPE) | CHAR30 | 30 Characters | 20060918 | |||
| 4 | IV_W_MSG_FIELD | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20060918 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Program error | 20060918 |
Method ALV_DISPLAY_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_DELETE_COUNTER | Call by reference | Type reference (TYPE) | I | Number of Processed Lines | 20061026 | |||
| 2 | IS_CONTENT | Call by reference | Type reference (TYPE) | ANY | 20060918 | ||||
| 3 | IT_EXCLUDED_FIELDS | Call by reference | Type reference (TYPE) | J_3R_EXCLUDED_FIELDS_TAB | Table of Excluded Fields of Single Data Structures | 20060918 | |||
| 4 | IV_NODE_TEXT | Call by reference | Type reference (TYPE) | AS4TEXT | Short Description of Repository Objects | 20060918 | |||
| 5 | IV_PARENT_NODE | Call by reference | Type reference (TYPE) | BALS_NODE_KEY | Node Key | 20060918 | |||
| 6 | IV_STRUCTURE_NAME | Call by reference | Type reference (TYPE) | CHAR30 | 30 Characters | 20060918 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error occurred while assigning field-symbol | 20060918 | ||
| 2 | Error occurred while creating category for ALV node | 20060918 | ||
| 3 | Error occurred while adding node to ALV | 20060918 | ||
| 4 | Program error | 20060918 | ||
| 5 | Structure was not found in DDIC | 20060918 |
Method ALV_GET_FIELDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_DD03P | Call by reference | Type reference (TYPE) | BALS_T_DD03P | Table containing the fields of the DDIC structure | 20060918 | |||
| 2 | IV_STRUCTURE_NAME | Call by reference | Type reference (TYPE) | CHAR30 | 30 Characters | 20060918 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Structure was not found in DDIC | 20060918 |
History
| Last changed by/on | SAP | 20100310 |
| SAP Release Created in | 604 |