SAP ABAP Class CL_PROGRESS_INDICATOR (Progress Indicator)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-CCM-ADK (Application Component) Archive Development Kit
⤷
S_ARCH_PROT (Package) Archiving: Logs
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-CCM-ADK (Application Component) Archive Development Kit⤷
S_ARCH_PROT (Package) Archiving: LogsProperties
| Class | CL_PROGRESS_INDICATOR | |
| Short Description | Progress Indicator | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | P | SAP Standard Production Program |
| Category | 0 | |
| Package | S_ARCH_PROT | Archiving: Logs |
| Created | 20041208 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_PROGRESS_INDICATOR has no forward declaration.
Interfaces
Class CL_PROGRESS_INDICATOR has no interface implemented.
Friends
Class CL_PROGRESS_INDICATOR has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PRV_CV_DATUM_NEXT |
Static Attribute | Private | Type reference (TYPE) | SY-DATUM | Date or Earliest, Next Progress Display | 20041213 | ||
| 2 | PRV_CV_TIME_NEXT |
Static Attribute | Private | Type reference (TYPE) | SY-UZEIT | Time of Earliest, Next Progress Display | 20041213 | ||
| 3 | PUB_CV_ARFC_CALL |
Static Attribute | Public | Type reference (TYPE) | BOOLE_D | X = Call takes place in aRFC context | 20070327 | ||
| 4 | V_LAST_PERCENT_PROGRESS_SENT |
Static Attribute | Public | Type reference (TYPE) | INT4 | The last displayed percentage progress | 20090928 | ||
| 5 | V_LAST_PROGRESS_IMMEDIATELY |
Static Attribute | Public | Type reference (TYPE) | BOOLE_D | 'X' = the last call was with I_OUTPUT_IMMEDIATELY = 'X' | 20090928 | ||
| 6 | V_METHOD_CALLRATE |
Static Attribute | Public | Type reference (TYPE) | INT4 | Number of Correct Calls of the Method | 20090928 | ||
| 7 | V_PERCENT_PROGRESS_USED |
Static Attribute | Public | Type reference (TYPE) | BOOLE_D | X = percentage progress display is used | 20090928 | ||
| 8 | V_PROGRESS_SENT_TREATMENT_OK |
Static Attribute | Public | Type reference (TYPE) | BOOLE_D | 'X' | Handling of E_PROGRESS_SENT OK? | 20090928 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ASYNCHRONOUS_RFC_CALL |
Static method | Public | Method | Determining whether the call takes place in aRFC context | 20070327 |
| 2 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | 20070327 | |
| 3 | PROGRESS_INDICATE |
Static method | Public | Method | Transfer of a Progress Message (for Background/Online) | 20041213 |
| 4 | PROGRESS_INDICATE_WITH_COMMIT |
Static method | Public | Method | PROGRESS_INDICATE with DB Commit, if Required | 20090928 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | ON_PROGRESS_OUTPUT | Static Event (1) |
Public (2) |
Displaying progress information | 20041208 |
Types
Class CL_PROGRESS_INDICATOR has no local type.
Method Signatures
Method ASYNCHRONOUS_RFC_CALL Signature
Method ASYNCHRONOUS_RFC_CALL on class CL_PROGRESS_INDICATOR has no parameter.
Method ASYNCHRONOUS_RFC_CALL on class CL_PROGRESS_INDICATOR has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_PROGRESS_INDICATOR has no parameter.
Method CLASS_CONSTRUCTOR on class CL_PROGRESS_INDICATOR has no exception.
Method PROGRESS_INDICATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
E_PROGRESS_SENT | Call by reference | Type reference (TYPE) | BOOLE_D | X = Fortschrittsinformation wurde ausgegeben | 20041213 | ||
| 2 |  Importing |
I_MSGID | Call by reference | Type reference (TYPE) | SY-MSGID | Nachrichtenklasse (Falls I_TEXT nicht übergeben wird) | 20041213 | ||
| 3 | Importing |
I_MSGNO | Call by reference | Type reference (TYPE) | SY-MSGNO | Nachrichtennummer (Falls I_TEXT nicht übergeben wird) | 20041213 | ||
| 4 | Importing |
I_MSGV1 | Call by reference | Type reference (TYPE) | ANY | Nachrichtenvariable (maximal 50 Zeichen) | 20041213 | ||
| 5 | Importing |
I_MSGV2 | Call by reference | Type reference (TYPE) | ANY | Nachrichtenvariable (maximal 50 Zeichen) | 20041213 | ||
| 6 | Importing |
I_MSGV3 | Call by reference | Type reference (TYPE) | ANY | Nachrichtenvariable (maximal 50 Zeichen) | 20041213 | ||
| 7 | Importing |
I_MSGV4 | Call by reference | Type reference (TYPE) | ANY | Nachrichtenvariable (maximal 50 Zeichen) | 20041213 | ||
| 8 | Importing |
I_OUTPUT_IMMEDIATELY | Call by reference | Type reference (TYPE) | BOOLE_D | X = den Fortschritt sofort ausgeben | 20041213 | ||
| 9 | Importing |
I_PROCESSED | Call by reference | Type reference (TYPE) | SY-TABIX | Anzahl bereits bearbeiteter Objekte | 20041213 | ||
| 10 | Importing |
I_TEXT | Call by reference | Type reference (TYPE) | ANY | Fortschrittstext (wenn keine Nachricht in I_MSG* übergeben w | 20041213 | ||
| 11 | Importing |
I_TOTAL | Call by reference | Type reference (TYPE) | SY-TABIX | Gesamtzahl der zu bearbeitenden Objekte | 20041213 |
Method PROGRESS_INDICATE on class CL_PROGRESS_INDICATOR has no exception.
Method PROGRESS_INDICATE_WITH_COMMIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_PROGRESS_SENT | Call by reference | Type reference (TYPE) | BOOLE_D | X = Fortschrittsinformation wurde ausgegeben | 20090928 | ||
| 2 | Importing |
I_MSGID | Call by reference | Type reference (TYPE) | SY-MSGID | Nachrichtenklasse (Falls I_TEXT nicht übergeben wird) | 20090928 | ||
| 3 | Importing |
I_MSGNO | Call by reference | Type reference (TYPE) | SY-MSGNO | Nachrichtennummer (Falls I_TEXT nicht übergeben wird) | 20090928 | ||
| 4 | Importing |
I_MSGV1 | Call by reference | Type reference (TYPE) | ANY | Nachrichtenvariable (maximal 50 Zeichen) | 20090928 | ||
| 5 | Importing |
I_MSGV2 | Call by reference | Type reference (TYPE) | ANY | Nachrichtenvariable (maximal 50 Zeichen) | 20090928 | ||
| 6 | Importing |
I_MSGV3 | Call by reference | Type reference (TYPE) | ANY | Nachrichtenvariable (maximal 50 Zeichen) | 20090928 | ||
| 7 | Importing |
I_MSGV4 | Call by reference | Type reference (TYPE) | ANY | Nachrichtenvariable (maximal 50 Zeichen) | 20090928 | ||
| 8 | Importing |
I_OUTPUT_IMMEDIATELY | Call by reference | Type reference (TYPE) | BOOLE_D | X = den Fortschritt sofort ausgeben | 20090928 | ||
| 9 | Importing |
I_PROCESSED | Call by reference | Type reference (TYPE) | SY-TABIX | Anzahl bereits bearbeiteter Objekte | 20090928 | ||
| 10 | Importing |
I_TEXT | Call by reference | Type reference (TYPE) | ANY | Fortschrittstext (wenn keine Nachricht in I_MSG* übergeben w | 20090928 | ||
| 11 | Importing |
I_TOTAL | Call by reference | Type reference (TYPE) | SY-TABIX | Gesamtzahl der zu bearbeitenden Objekte | 20090928 |
Method PROGRESS_INDICATE_WITH_COMMIT on class CL_PROGRESS_INDICATOR has no exception.
Event Signatures
Event ON_PROGRESS_OUTPUT Signature
Event ON_PROGRESS_OUTPUT on class CL_PROGRESS_INDICATOR has no parameter.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 700 |
