SAP ABAP Class CL_STCTM_LOG (Task Log)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-INS-TC-RT (Application Component) Runtime for ABAP based automated TC
     ⤷ STC_TM (Package) Technical Configuration Task Management

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SERIALIZABLE_OBJECT	Serializable Object	20101115

Properties

Class	CL_STCTM_LOG
Short Description	Task Log
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class	STC_TM
Program status
Category	0
Package	STC_TM	Technical Configuration Task Management
Created	20101115	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_STC_TASK_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_STCTM_TASK	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_STC_CONSTANTS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SERIALIZABLE_OBJECT	☐	☐	Serializable Object	20101115

Friends

#	Friend	Modeled only	Created on	Description
1	CL_STCTM_DUMMY_TASK	☐	20121220	Dummy Task (not selectable, not executable)
2	CL_STCTM_LOG_DISPLAY	☐	20130516	Task Log Display
3	CL_STCTM_PREPROCESSOR	☐	20120203	Task List Run/Variant Preprocessor (User Interface)
4	CL_STCTM_SESSION	☐	20130507	Task List Run
5	CL_STCTM_TASKLIST	☐	20120110	Configured List of Tasks
6	CL_STCTM_TASK_STATISTICS	☐	20130514	Task Statistics
7	CL_STCTM_XML_UTILITIES	☐	20121005	Helper methods for XML processing
8	CL_STC_EVENT_FACTORY	☐	20121128	Factory for Technical Configuration Events
9	CL_STC_TASK_FACTORY	☐	20120326	Factory for Technical Configuration Tasks

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DUMMY	Instance attribute	Public	☐	Type reference (TYPE)	STRING		Dummy string for MESSAGE ... INTO dummy	20110119
2	PT_ACTION	Instance attribute	Private	☐	Type reference (TYPE)	TT_ACTION		Action and History entries	20130507
3	PT_LOG	Instance attribute	Public	☑	Type reference (TYPE)	TT_LOG		Table with BAPI return information	20101115

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BAPIRET	Instance method	Public	Method	Add single BAPIRET message to log	20101115
2	ADD_BAPIRETTAB	Instance method	Public	Method	Add BAPIRET table to log	20110114
3	ADD_EXCEPTION	Instance method	Public	Method	Add exception to log	20101115
4	ADD_JOBLOG	Instance method	Public	Method	Add job log to task log	20120725
5	ADD_SYST	Instance method	Public	Method	Add system message to log	20101115
6	ADD_T100	Instance method	Public	Method	Add T100 message to log	20110114
7	ADD_TEXT	Instance method	Public	Method	Add simple text to log	20101115
8	CLEAR	Instance method	Private	Method	Clear log completely including status	20101206
9	GET_BAPIRETTAB	Instance method	Public	Method	Get log entries as BAPIRET table from log	20110221
10	_ADD_T100	Instance method	Private	Method	Add T100 message to log (intern)	20120725
11	_ADD_TSTPINT	Instance method	Private	Method	Add last changed informations to log entry	20101115

Events

Class CL_STCTM_LOG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_ACTION	Private	See coding		Action entry	20130507	BEGIN OF ts_action, exec_id TYPE stc_exec_id, "identifier of execution or checkrun period TYPE stc_exec_period, "checkrun, execution or maintenance period batch TYPE sy-batch, "executed in batch? starttime TYPE timestampl, "more precise than stc_timestamp, endtime TYPE timestampl, "more precise than stc_timestamp, check_status TYPE stc_task_check_status, "for history check_progress TYPE stc_task_progress, "for history status TYPE stc_task_status, "for history progress TYPE stc_task_progress, "for history END OF ts_action
2	TS_LOG	Public	See coding		Log entry	20101115	BEGIN OF ts_log . INCLUDE TYPE bapiret2. INCLUDE TYPE ts_tstpint. TYPES: details TYPE string, exec_id TYPE stc_exec_id, "identifier of execution or checkrun period TYPE stc_exec_period, "checkrun, execution or maintenance period activity TYPE stc_exec_activity, "message belongs to an execution activity END OF ts_log
3	TS_TSTPINT	Public	See coding		Additional attributes for log entry	20101115	BEGIN OF ts_tstpint, tstpnm TYPE syuname, timestmp TYPE stc_timestamp, END OF ts_tstpint
4	TT_ACTION	Private	See coding		Action entries	20130507	tt_action TYPE STANDARD TABLE OF ts_action
5	TT_LOG	Public	See coding		Log entries	20101115	tt_log TYPE STANDARD TABLE OF ts_log

Method Signatures

Method ADD_BAPIRET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BAPIRET	Call by reference	☐	Type reference (TYPE)	BAPIRET2		Single BAPIRET message	20101115
2	Importing	I_DETAILS	Call by reference	☑	Type reference (TYPE)	STRING		Detail information for callback	20110118

Method ADD_BAPIRET on class CL_STCTM_LOG has no exception.

Method ADD_BAPIRETTAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BAPIRETTAB	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPIRET messages	20110114
2	Importing	I_DETAILS	Call by reference	☑	Type reference (TYPE)	STRING		Detail information for callback	20110118

Method ADD_BAPIRETTAB on class CL_STCTM_LOG has no exception.

Method ADD_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IRX_ROOT	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract superclass for all global exceptions	20101115
2	Importing	I_DETAILS	Call by reference	☑	Type reference (TYPE)	STRING		Detail information for callback	20110118

Method ADD_EXCEPTION on class CL_STCTM_LOG has no exception.

Method ADD_JOBLOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_MSG_COUNT	Call by reference	☐	Type reference (TYPE)	I		Number of messages added to the log	20120726
2	Importing	IV_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT		Job ID	20120726
3	Importing	IV_JOBNAME	Call by reference	☐	Type reference (TYPE)	BTCJOB		Background job name	20120726
4	Importing	IV_MSGTY_FILTER	Call by reference	☑	Type reference (TYPE)	CLIKE		Filter for message types to be added	20120727

Method ADD_JOBLOG on class CL_STCTM_LOG has no exception.

Method ADD_SYST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DETAILS	Call by reference	☑	Type reference (TYPE)	STRING		Detail information for callback	20110118

Method ADD_SYST on class CL_STCTM_LOG has no exception.

Method ADD_T100 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DETAILS	Call by reference	☑	Type reference (TYPE)	STRING		Detail information for callback	20110118
2	Importing	IV_MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message class	20110114
3	Importing	IV_MSGNO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message number	20110114
4	Importing	IV_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message type	20110114
5	Importing	IV_MSGV1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message variable	20110114
6	Importing	IV_MSGV2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message variable	20110114
7	Importing	IV_MSGV3	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message variable	20110114
8	Importing	IV_MSGV4	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message variable	20110114

Method ADD_T100 on class CL_STCTM_LOG has no exception.

Method ADD_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DETAILS	Call by reference	☑	Type reference (TYPE)	STRING		Detail information for callback	20110118
2	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	BAPI_MSG		Message text	20101115
3	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Message type	20101115

Method ADD_TEXT on class CL_STCTM_LOG has no exception.

Method CLEAR Signature

Method CLEAR on class CL_STCTM_LOG has no parameter.
Method CLEAR on class CL_STCTM_LOG has no exception.

Method GET_BAPIRETTAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BAPIRETTAB	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPIRET messages	20110221

Method GET_BAPIRETTAB on class CL_STCTM_LOG has no exception.

Method _ADD_T100 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DETAILS	Call by reference	☑	Type reference (TYPE)	STRING		Detail information for callback	20120725
2	Importing	IV_MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message class	20120725
3	Importing	IV_MSGNO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message number	20120725
4	Importing	IV_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message type	20120725
5	Importing	IV_MSGV1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message variable	20120725
6	Importing	IV_MSGV2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message variable	20120725
7	Importing	IV_MSGV3	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message variable	20120725
8	Importing	IV_MSGV4	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message variable	20120725
9	Importing	IV_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	STC_TIMESTAMP		Timestamp	20120725
10	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	User Name	20120725

Method _ADD_T100 on class CL_STCTM_LOG has no exception.

Method _ADD_TSTPINT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_LOG	Call by reference	☐	Type reference (TYPE)	TS_LOG		Log entry	20101115

Method _ADD_TSTPINT on class CL_STCTM_LOG has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	703