SAP ABAP Class CL_SWF_TRC_HANDLE (Logical Trace Handle)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-BMT-WFM (Application Component) SAP Business Workflow
     SWF_TRC (Package) Workflow: Trace
Properties
Class CL_SWF_TRC_HANDLE  
Short Description Logical Trace Handle    
Super Class    
Instantiability of a Class 0  Private 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SWF_TRC   Workflow: Trace 
Created 20040510   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 T Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_SWF_TRC_HANDLE has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_SWF_TRC_MANAGER 20040510 Trace Manager
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MC_COMMIT_ALL Static Attribute Public Type reference (TYPE) CHAR01 'A' Save All or Nothing 20060111
2 MC_COMMIT_PART Static Attribute Public Type reference (TYPE) CHAR01 'P' Saving All Changes That Could Be Accepted 20060111
3 MC_TRC_DATA_ELEMENT Instance attribute Private Type reference (TYPE) SWFDNAME 'TraceData' Element name for anonymously transferred data 20040518
4 MT_PHANDLES Instance attribute Private Type reference (TYPE) T_PHANDLE_TAB 20040510
5 M_COMPONENT Instance attribute Private Type reference (TYPE) SWFTRC_CMP Trace Components 20040510
6 M_CTXT_REF Instance attribute Private Object reference (TYPE REF TO) DATA Current application context 20040510
7 M_CTX_TYPE Instance attribute Private Type reference (TYPE) DOMNAME 'CHAR255' Data type name of application context structure 20040514
8 M_HAS_ACTIVE_HANDLE Instance attribute Private Type reference (TYPE) XFLAG 'X' - at least one active handle available 20040510
9 M_ID Instance attribute Private Type reference (TYPE) SWFTRACEID ID of logical handle - transient 20040510
10 M_LPOINT Instance attribute Private Type reference (TYPE) SWFTRCLPNT Current trace time (part of context) 20040510
11 M_ROLL_AREA_ID Instance attribute Private Type reference (TYPE) SWFTRACEID ID of separate roll area 20040510
12 M_WILL_WRITE Instance attribute Private Type reference (TYPE) XFLAG 'T' - Write-call will write data 20040513
Methods
# Method Level Visibility Method type Description Created on
1 CALLBACK Instance method Public Method Trace calls back to determine data for the entry 20040512
2 CLONE Instance method Private Method Copy Handle 20040514
3 CONSTRUCTOR Instance method Public Constructor Constructor 20040510
4 DISPLAY Instance method Public Method Display list of managed physical traces 20040609
5 END_PACKAGE Instance method Public Method Setting (software) package END 20040518
6 GET_APP_CONTEXT Instance method Public Method Return current application context 20040521
7 GET_APP_CONTEXT_REF Instance method Public Method Return reference to application context 20040510
8 GET_APP_CONTEXT_TYPE Instance method Public Method Return type name of application context struture 20040510
9 GET_CODEPOINT Instance method Public Method Read code point of application 20040510
10 GET_COMPONENT Instance method Public Method Read trace application component 20040510
11 GET_EVENT Instance method Public Method Read logical time 20040510
12 GET_PACKAGE Instance method Public Method Read (software) package 20040510
13 GET_PHYSICAL_HANDLES Instance method Private Method Add physical handles 20040521
14 GET_PHYSICAL_HANDLE_IDS Instance method Public Method Add physical handles 20060621
15 GET_ROLL_AREA_ID Instance method Private Method ID that identifies current role area 20040510
16 GET_TRACE_ID Instance method Public Method Return Trace ID 20040510
17 GET_TRACE_LEVEL Instance method Public Method Determines (maximum) trace level 20040514
18 GET_TRACE_POINT Instance method Public Method Read logical time (package+event+codepoint) 20040513
19 IS_ACTIVE Instance method Public Method 'X' - active physical handle available 20040510
20 NEEDS_PROPAGATE Instance method Public Method 'X' - Also trace sub-objects 20040521
21 PROPAGATE Instance method Public Method Create sub-trace(s) for physical traces to be propagated 20040521
22 PUBLISH_LOCAL Instance method Public Method Publish all local traces 20040510
23 PUSH_CONTEXT Instance method Private Method Logical stack time (package+event+codepoint) 20040510
24 SET_CODEPOINT Instance method Public Method Sets application codepoint 20040510
25 SET_CONTEXT Instance method Public Method Set context: package+event+codepoint+app. extension 20040513
26 SET_EVENT Instance method Public Method Setting logical time 20040510
27 SET_PACKAGE Instance method Public Method Setting (software) package START 20040510
28 SET_PHYSICAL_HANDLES Instance method Private Method Add physical handles 20040510
29 SET_TITLE_FOR_NEW Instance method Public Method Change Title of Traces Created from Patterns 20060111
30 UNWRAP_EXCEPTION Instance method Private Method Convert exception hierarchy to message list 20040517
31 UPDATE_APP_CONTEXT_REF Instance method Public Method Return reference to application context 20040514
32 WILL_WRITE Instance method Private Method 'X' - at least one physical trace was written 20040510
33 WRITE Instance method Public Method Write and transfer trace entry directly 20040512
34 WRITE_EXCEPTION Instance method Public Method Write and transfer trace entry directly 20040517
35 WRITE_TRACE_LINK Instance method Public Method Write and transfer trace entry directly 20040517
Events
Class CL_SWF_TRC_HANDLE has no event.
Types
Class CL_SWF_TRC_HANDLE has no local type.
Method Signatures

Method CALLBACK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CALLBACK_INSTANCE Call by reference Object reference (TYPE REF TO) IF_SWF_TRC_CALLBACK Container mit zu tracenden Daten 20040512
2 Returning ENTRY_COUNT Value transfer Type reference (TYPE) INT4 Anzahl geschriebener Trace-Einträge 20040513

Method CALLBACK on class CL_SWF_TRC_HANDLE has no exception.

Method CLONE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NEW_HANDLE Value transfer Object reference (TYPE REF TO) CL_SWF_TRC_HANDLE Logisches Trace-Handle 20040514

Method CLONE on class CL_SWF_TRC_HANDLE has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing APP_FILTER_REF Call by reference Object reference (TYPE REF TO) DATA Referenz auf Anwendungskontext-Struktur 20040510
2 Importing CODEPOINT Call by reference Type reference (TYPE) SWFTRC_PNT Trace: Physischer Trace-Punkt (Code-Referenz) 20040510
3 Importing COMPONENT Call by reference Type reference (TYPE) SWFTRC_CMP Trace: Name der Tracenden Komponente 20040510
4 Importing CTX_STRUCT Call by reference Type reference (TYPE) DOMNAME Typ der anwendungsspezifischen Kontextstruktur 20040514
5 Importing EVENT Call by reference Type reference (TYPE) SWFTRC_EVT Trace: Logischer Zeitpunkt für Trace-Eintrag 20040510
6 Importing PACKAGE Call by reference Type reference (TYPE) SWFTRC_PCK Trace: Softwarepaket der Anwendung 20040510
7 Importing PHYSICAL_HANDLES Call by reference Type reference (TYPE) SWFTRCPTAB Trace: Liste physikalischer Trace-Handles 20040510
8 Importing ROLL_AREA_ID Call by reference Type reference (TYPE) SWFTRACEID Kennung des eigenen Rollbereichs 20040510
9 Importing TRACE_ID Call by reference Type reference (TYPE) SWFTRACEID Kennung des logischen Trace (transient!) 20040510
# Exception Resumable Description Created on
1 CX_SWF_TRC_TRACE Komponentenkonfiguration ungültig 20040510

Method DISPLAY Signature

Method DISPLAY on class CL_SWF_TRC_HANDLE has no parameter.
Method DISPLAY on class CL_SWF_TRC_HANDLE has no exception.

Method END_PACKAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing TRACE_PACKAGE Value transfer Type reference (TYPE) SWFTRC_PCK (Software-)Paket wird verlassen 20040526

Method END_PACKAGE on class CL_SWF_TRC_HANDLE has no exception.

Method GET_APP_CONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting APP_CONTEXT Value transfer Type reference (TYPE) ANY Anwendungsspezifische Kontextstruktur 20040521

Method GET_APP_CONTEXT on class CL_SWF_TRC_HANDLE has no exception.

Method GET_APP_CONTEXT_REF Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning APP_CONTEXT_REF Value transfer Object reference (TYPE REF TO) DATA 20040510

Method GET_APP_CONTEXT_REF on class CL_SWF_TRC_HANDLE has no exception.

Method GET_APP_CONTEXT_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning APP_CONTEXT_TYPE Value transfer Type reference (TYPE) STRING Typname der Anwendungs-Kontextstruktur 20040510

Method GET_APP_CONTEXT_TYPE on class CL_SWF_TRC_HANDLE has no exception.

Method GET_CODEPOINT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CODEPOINT Value transfer Type reference (TYPE) SWFTRC_PNT Trace: Code-Point 20040510

Method GET_CODEPOINT on class CL_SWF_TRC_HANDLE has no exception.

Method GET_COMPONENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning COMPONENT Value transfer Type reference (TYPE) SWFTRC_CMP Applikation, dem der Trace zugeordnet ist 20040510

Method GET_COMPONENT on class CL_SWF_TRC_HANDLE has no exception.

Method GET_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EVENT Value transfer Type reference (TYPE) SWFTRC_EVT Logischer Zeitpunkt dieses Eintrags 20040510

Method GET_EVENT on class CL_SWF_TRC_HANDLE has no exception.

Method GET_PACKAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PACKAGE Value transfer Type reference (TYPE) SWFTRC_PCK (Software-)Paket dieses Eintrags auslesen 20040510

Method GET_PACKAGE on class CL_SWF_TRC_HANDLE has no exception.

Method GET_PHYSICAL_HANDLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting PHYSICAL_HANDLES Call by reference Type reference (TYPE) SWFTRCPTAB Trace: Liste physikalischer Trace-Handles 20040521

Method GET_PHYSICAL_HANDLES on class CL_SWF_TRC_HANDLE has no exception.

Method GET_PHYSICAL_HANDLE_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TRACE_IDS Value transfer Type reference (TYPE) SWFTRCIDSTAB Trace: ID-Liste physikalischer Trace-Handles 20060621

Method GET_PHYSICAL_HANDLE_IDS on class CL_SWF_TRC_HANDLE has no exception.

Method GET_ROLL_AREA_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ROLL_AREA_ID Value transfer Type reference (TYPE) SWFTRACEID Kennung des aktuellen Rollbereichs 20040510

Method GET_ROLL_AREA_ID on class CL_SWF_TRC_HANDLE has no exception.

Method GET_TRACE_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TRACE_ID Value transfer Type reference (TYPE) SWFTRACEID Eindeutige Kennung im Trace 20040510

Method GET_TRACE_ID on class CL_SWF_TRC_HANDLE has no exception.

Method GET_TRACE_LEVEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TRACE_LEVEL Value transfer Type reference (TYPE) SWFTRCLEV Max. Trace-Level aller referenzierten physikalischen Handles 20040514

Method GET_TRACE_LEVEL on class CL_SWF_TRC_HANDLE has no exception.

Method GET_TRACE_POINT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TRACE_CONTEXT Value transfer Type reference (TYPE) SWFTRCLPNT Trace: Definition eines logischen Zeitpunktes 20040513

Method GET_TRACE_POINT on class CL_SWF_TRC_HANDLE has no exception.

Method IS_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning IS_ACTIVE Value transfer Type reference (TYPE) XFLAG 'X' - mindestens ein aktives Handle vorhanden 20040510

Method IS_ACTIVE on class CL_SWF_TRC_HANDLE has no exception.

Method NEEDS_PROPAGATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NEEDS_PROPAGATE Value transfer Type reference (TYPE) XFLAG 'X' - mindestens ein Handle erfordert Propagierung 20040521

Method NEEDS_PROPAGATE on class CL_SWF_TRC_HANDLE has no exception.

Method PROPAGATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing APP_FILTER Call by reference Type reference (TYPE) ANY Anwendungs-Filter (ein- oder mehrzeilig) 20040521
2 Importing DESCRIPTION Call by reference Type reference (TYPE) SWFTRCHDSC Trace: Sprachunabhängige Beschreibung des Trace 20040521
3 Importing LOCAL Call by reference Type reference (TYPE) XFLAG 'X' - Trace nur im aktuellen Rollbereich aktiv 20040521
4 Importing NO_DISPLAY Call by reference Type reference (TYPE) XFLAG 'X' - Trace nicht im Trace-Katalog anzeigen 20040521
5 Exporting NUM_SUBTRACES_CREATED Call by reference Type reference (TYPE) INT4 Anzahl neu angelegter physikalischer Sub-Traces 20040521
6 Importing PROPAGATE Call by reference Type reference (TYPE) XFLAG 'X' 'X' - Anwendung soll auch Sub-Objekte tracen 20040521
7 Exporting SUB_TRACE_HANDLE Call by reference Object reference (TYPE REF TO) CL_SWF_TRC_HANDLE Trace-Handle, das auf denSub-Trace zeigt 20040521
8 Importing SYSTEM Call by reference Type reference (TYPE) XFLAG 'X' - Trace wurde 'vom System initiiert' 20040521
9 Importing TEXT Call by reference Type reference (TYPE) STRING Trace: Erläuternder Text 20040521
10 Importing TRACE_LEVEL Call by reference Type reference (TYPE) TRC_LEVEL Trace-Level (1..9) 20040521
11 Importing USER Call by reference Type reference (TYPE) SYUNAME Benutzer, unter dem der Trace geführt werden soll 20040521
# Exception Resumable Description Created on
1 CX_SWF_TRC_TRACE Fehler im Trace 20040521

Method PUBLISH_LOCAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FILTER_ADD Call by reference Type reference (TYPE) ANY Neue Filterkriterien, für alle Zeilen 20040510
2 Importing FILTER_REMOVE Call by reference Type reference (TYPE) ANY Zu entfernende Filterkriterien, für alle Zeilen 20040510
3 Exporting NUM_PUBLISHED Call by reference Type reference (TYPE) INT4 Anzahl publizierter (physikalischer) Traces 20040510
# Exception Resumable Description Created on
1 CX_SWF_TRC_TRACE Fehler beim Publizieren eines lokalen Trace 20040510

Method PUSH_CONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LOGICAL_CONTEXT Value transfer Type reference (TYPE) SWFTRCLPNT Trace: Definition eines logischen Zeitpunktes 20040510

Method PUSH_CONTEXT on class CL_SWF_TRC_HANDLE has no exception.

Method SET_CODEPOINT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CODEPOINT Value transfer Type reference (TYPE) SWFTRC_PNT Trace: Code-Point 20040510

Method SET_CODEPOINT on class CL_SWF_TRC_HANDLE has no exception.

Method SET_CONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing APP_CONTEXT Call by reference Type reference (TYPE) ANY Anwendung: Header-Erweiterungsstruktur 20040513
2 Importing TRACE_CONTEXT Call by reference Type reference (TYPE) SWFTRCLPNT Trace: Definition eines logischen Zeitpunktes 20040513

Method SET_CONTEXT on class CL_SWF_TRC_HANDLE has no exception.

Method SET_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EVENT Value transfer Type reference (TYPE) SWFTRC_EVT Logischer Zeitpunkt dieses Eintrags 20040510

Method SET_EVENT on class CL_SWF_TRC_HANDLE has no exception.

Method SET_PACKAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PACKAGE Value transfer Type reference (TYPE) SWFTRC_PCK (Software-)Paket dieses Eintrags auslesen 20040510

Method SET_PACKAGE on class CL_SWF_TRC_HANDLE has no exception.

Method SET_PHYSICAL_HANDLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CLEAR_BEFORE_ADD Call by reference Type reference (TYPE) XFLAG 'X' - vorhandene Handles löschen. 20040510
2 Importing PHYSICAL_HANDLES Call by reference Type reference (TYPE) SWFTRCPTAB Trace: Liste physikalischer Trace-Handles 20040510

Method SET_PHYSICAL_HANDLES on class CL_SWF_TRC_HANDLE has no exception.

Method SET_TITLE_FOR_NEW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NEW_TITLE Call by reference Type reference (TYPE) SWFTRCHDSC Trace-Header: Beschreibender Text 20060111
2 Exporting RETURNCODE Call by reference Type reference (TYPE) INT1 0 alles geändert; 1 teilweise geändert; 2 nichts geändert 20060111
3 Importing TRANSACTIONAL_BEHAVIOR Call by reference Type reference (TYPE) CHAR01 MC_COMMIT_PART Schreibe: A alles oder nichts; oder P mögl. Änderungen 20060111

Method SET_TITLE_FOR_NEW on class CL_SWF_TRC_HANDLE has no exception.

Method UNWRAP_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXCEPTION Call by reference Object reference (TYPE REF TO) CX_ROOT Ausnahme 20040517
2 Changing MESSAGE_LIST Call by reference Type reference (TYPE) SWFTRCMSGTAB Liste mit Meldungen 20040517

Method UNWRAP_EXCEPTION on class CL_SWF_TRC_HANDLE has no exception.

Method UPDATE_APP_CONTEXT_REF Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing APP_CONTEXT_REF Call by reference Object reference (TYPE REF TO) DATA Kontextinformation, die übernommen weden soll 20040514
2 Importing OVERWRITE Call by reference Type reference (TYPE) XFLAG 'X' - replace, ' ' - non-destructive fill of initial fields 20040514

Method UPDATE_APP_CONTEXT_REF on class CL_SWF_TRC_HANDLE has no exception.

Method WILL_WRITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTAINER Call by reference Object reference (TYPE REF TO) IF_SWF_CNT_CONTAINER Datenkontext 20040513
2 Exporting WILL_WRITE Call by reference Type reference (TYPE) XFLAG 'X' - mindestens eine Trace-Bedingung ist erfüllt 20040510
3 Exporting WRITABLE_HANDLES Call by reference Type reference (TYPE) SWFTRCPTAB Trace: Liste physikalischer Trace-Handles 20040513

Method WILL_WRITE on class CL_SWF_TRC_HANDLE has no exception.

Method WRITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COMMENT Call by reference Type reference (TYPE) STRING Kommentar zu diesem Trace-Eintrag 20040517
2 Importing DATA Call by reference Type reference (TYPE) ANY Zu tracende Daten (Container oder beliebige Struktur) 20040512
3 Returning ENTRY_COUNT Value transfer Type reference (TYPE) INT4 Anzahl geschriebener Trace-Einträge 20040512

Method WRITE on class CL_SWF_TRC_HANDLE has no exception.

Method WRITE_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ENTRY_COUNT Value transfer Type reference (TYPE) INT4 Anzahl geschriebener Trace-Einträge 20040517
2 Importing EXCEPTION Call by reference Object reference (TYPE REF TO) CX_STATIC_CHECK Zu tracende Ausnahme 20040517

Method WRITE_EXCEPTION on class CL_SWF_TRC_HANDLE has no exception.

Method WRITE_TRACE_LINK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COMMENT Call by reference Type reference (TYPE) STRING Kommentar zu diesem Trace-Eintrag 20040517
2 Importing DATA Call by reference Type reference (TYPE) ANY Zu tracende Daten (Container oder beliebige Struktur) 20040517
3 Returning ENTRY_COUNT Value transfer Type reference (TYPE) INT4 Anzahl geschriebener Trace-Einträge 20040517
4 Importing TRACE_LINK Call by reference Type reference (TYPE) SWFTRACEID ID eines physikalischen Trace 20040517

Method WRITE_TRACE_LINK on class CL_SWF_TRC_HANDLE has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 700