SAP ABAP Class CL_ABAP_DOCU_INDEX (Methods for Indexing of ABAP Documentation)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
⤷
SABAPDOCU (Package) ABAP Documentation Objects in ABAP Workbench
⤷
⤷
Properties
| Class | CL_ABAP_DOCU_INDEX | |
| Short Description | Methods for Indexing of ABAP Documentation | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SABAPDOCU | ABAP Documentation Objects in ABAP Workbench |
| Created | 20050112 | SAP |
| Last change | 20130531 | 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_ABAP_DOCU_INDEX has no interface implemented.
Friends
Class CL_ABAP_DOCU_INDEX has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | Flag for Index Check | 20070327 | |||
| 2 | Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | Flag for Unit Test | 20071203 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Returns a List of Language Elements | 20070404 | |
| 2 | Static method | Public | Method | Returns a List of Documents with Executable Examples | 20071126 | |
| 3 | Static method | Public | Method | Fills Manual Index Table in Area CL_ABAP_DOCU_AREA | 20070404 | |
| 4 | Static method | Public | Method | Fills index table for system fields | 20120710 | |
| 5 | Static method | Public | Method | Creates Manual Index from Documents | 20071126 | |
| 6 | Static method | Public | Method | Creates index for system fields | 20120710 |
Events
Class CL_ABAP_DOCU_INDEX has no event.
Types
Class CL_ABAP_DOCU_INDEX has no local type.
Method Signatures
Method BUILD_ELEMENT_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ELEMENT_TAB | Call by reference | Type reference (TYPE) | STANDARD TABLE | 20070404 | ||||
| 2 | LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | 20070404 | ||||
| 3 | WITH_BUILTINS | Call by reference | Type reference (TYPE) | ABAP_BOOL | 'X' | 20070727 |
Method BUILD_ELEMENT_LIST on class CL_ABAP_DOCU_INDEX has no exception.
Method BUILD_EXAMPLE_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EXAMPLE_TAB | Value transfer | Attribute reference (LIKE) | CL_ABAP_DOCU_TABLES=>EXAMPLE_TAB | 20071126 | ||||
| 2 | LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | 20071126 |
Method BUILD_EXAMPLE_LIST on class CL_ABAP_DOCU_INDEX has no exception.
Method BUILD_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | Sprache | 20070404 |
Method BUILD_INDEX on class CL_ABAP_DOCU_INDEX has no exception.
Method BUILD_SYFIELD_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | Sprachenschlüssel der aktuellen Textumgebung | 20120710 |
Method BUILD_SYFIELD_INDEX on class CL_ABAP_DOCU_INDEX has no exception.
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | INDEX_DATE | Value transfer | Type reference (TYPE) | SY-DATUM | '00010101' | Änderungsdatum des aktuellen Index | 20071126 | ||
| 2 | INDEX_TAB | Call by reference | Type reference (TYPE) | CL_ABAP_DOCU=>ABAP_INDEX_TAB | Indextabelle | 20071126 | |||
| 3 | INDEX_TIME | Value transfer | Type reference (TYPE) | SY-UZEIT | '000000' | Änderungszeit des aktuellen Index | 20071126 | ||
| 4 | LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | SY-LANGU | Sprache | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method CREATE_SYFIELD_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | INDEX_TAB | Call by reference | Type reference (TYPE) | CL_ABAP_DOCU=>ABAP_INDEX_TAB | 20120710 | ||||
| 2 | LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | SY-LANGU | 20120710 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120710 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 700 |