SAP ABAP Class CL_SATC_CI_CHECK_MODULE (Abstract Adapter to CheckMan Check Plug-Ins)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO-ATF (Application Component) ABAP Test Frameworks ( ATC, CheckMan, Code Inspector)
     ⤷ SATC_CI_MODULES (Package) INTERNAL: - *NO* REUSE - "Code Inspector" specific modules

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SATC_MODULE	Module	20120208

Properties

Class	CL_SATC_CI_CHECK_MODULE
Short Description	Abstract Adapter to CheckMan Check Plug-Ins
Super Class	CL_SATC_MODULE	Module
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SATC_CI_MODULES	INTERNAL: - *NO* REUSE - "Code Inspector" specific modules
Created	20120208	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	IF_SATC_AC_PLNERR_DOMAIN_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_SATC_CI_CHECK_MODULE has no interface implemented.

Friends

Class CL_SATC_CI_CHECK_MODULE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_CFG_PARAM_CHK_VARIANT	Constant	Public	☐	Type reference (TYPE)	SATC_D_NAME	'CI_CHK_VARIANT'		20120521
2	C_CFG_PARAM_CODE_XMPT_MODE	Constant	Public	☐	Type reference (TYPE)	SATC_D_NAME	'CI_CODE_XMPT_MODE'		20130322
3	C_MODULE_ID	Constant	Public	☐	Type reference (TYPE)	SATC_D_ID	'0050569D554F1ED194DE37E23CA45FA9'	Check module ID	20120521
4	C_SET_PARAM_PLNERR	Constant	Public	☐	Type reference (TYPE)	SATC_D_NAME	'PLNERR'	Name of an Element (e.g. Variable)	20120521
5	C_SET_PARAM_TADIR	Constant	Public	☐	Type reference (TYPE)	SATC_D_NAME	'R3TR'	Name of an Element (e.g. Variable)	20120521
6	C_SET_PARAM_VERDICT	Constant	Public	☐	Type reference (TYPE)	SATC_D_NAME	'VERDICT'	Name of an Element (e.g. Variable)	20120521
7	F_CI_CHK_VARIANT	Instance attribute	Private	☐	Type reference (TYPE)	SATC_CI_CHK_VARIANT			20120320
8	F_CODE_INSPECTOR_ADAPTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SATC_CI_ADAPTER			20120208
9	F_DESCRIPTION_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SATC_CI_TEXT_HANDLE_MANAGER			20130528
10	F_FNDNG_XMPTD_IN_CODE	Instance attribute	Private	☐	Type reference (TYPE)	SATC_D_AC_MODE_FND_XTD_IN_CODE			20130322
11	F_LOG	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SATC_LOG_WRITER		Log writer	20120208
12	F_LOG_CNT	Instance attribute	Private	☐	Type reference (TYPE)	I		Counter for logged Issues	20120208
13	F_MODULE_ID	Instance attribute	Private	☐	Type reference (TYPE)	SATC_D_ID		Module ID	20120208
14	F_PHASE_KEY	Instance attribute	Private	☐	Type reference (TYPE)	IF_SATC_AC_PLNERR_DOMAIN_TYPES=>TY_D_PHASE_KEY		Key of Phase that is/was in Processing	20120208
15	F_PLNERR_API	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SATC_AC_PLNERR_API		Plugin Error Domain: Create and Add new Verdict	20120208
16	F_PREREQ_MET	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	'I'		20120208
17	F_R3TR_HNDL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SATC_SET_READ_ITERATE		'Read & Iterate' access to set	20120208
18	F_R3TR_KEYS_TO_CHECK	Instance attribute	Private	☐	Type reference (TYPE)	SATC_T_R3TR_KEYS			20120516
19	F_VERDICT_API	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SATC_AC_VERDCT_API		Verdict Domain: Create and Add new Verdict	20120208

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TO_PLNERR_SET	Instance method	Private	Method		20120515
2	GET_CI_CHK_VARIANT_FROM_CONFIG	Instance method	Private	Method		20120424
3	GET_NAME_AND_DESCRIPTION	Instance method	Private	Method		20120515
4	INIT_R3TR_KEYS_TO_CHECK	Instance method	Private	Method		20120516
5	PROCESS_CI_FAILURES	Instance method	Private	Method		20130325
6	PROCESS_CI_FINDINGS	Instance method	Private	Method		20130528
7	REMOVE_WRAPPING_EXCEPTIONS	Instance method	Private	Method		20120515
8	RUN_CHECKS_AND_PROCESS_RESULTS	Instance method	Private	Method		20120515
9	SET_CHECK_MODULE_EXCEPTION	Instance method	Private	Method		20120209
10	SET_EXECUTION_ABORTED	Instance method	Private	Method		20120515
11	SET_PREREQUISITE_NOT_MET	Instance method	Private	Method		20120515
12	WRITE_EXCEPTION_TO_LOG	Instance method	Private	Method		20120515

Events

Class CL_SATC_CI_CHECK_MODULE has no event.

Types

Class CL_SATC_CI_CHECK_MODULE has no local type.

Method Signatures

Method ADD_TO_PLNERR_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20120515
2	Importing	I_PLNERR_TYPE	Call by reference	☐	Type reference (TYPE)	IF_SATC_AC_PLNERR_DOMAIN_TYPES=>TY_D_MESSAGE_KEY			20120515

Method ADD_TO_PLNERR_SET on class CL_SATC_CI_CHECK_MODULE has no exception.

Method GET_CI_CHK_VARIANT_FROM_CONFIG Signature

Method GET_CI_CHK_VARIANT_FROM_CONFIG on class CL_SATC_CI_CHECK_MODULE has no parameter.
Method GET_CI_CHK_VARIANT_FROM_CONFIG on class CL_SATC_CI_CHECK_MODULE has no exception.

Method GET_NAME_AND_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_SATC_AC_TEXT_HANDLE_STACK			20120515
2	Exporting	E_EXCEPTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120515
3	Importing	I_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT			20120515
4	Importing	I_EXEC_PHASE	Call by reference	☐	Type reference (TYPE)	CX_SATC_CI_CHECK_ERRORS=>TY_EXECUTION_PHASE			20120515

Method GET_NAME_AND_DESCRIPTION on class CL_SATC_CI_CHECK_MODULE has no exception.

Method INIT_R3TR_KEYS_TO_CHECK Signature

Method INIT_R3TR_KEYS_TO_CHECK on class CL_SATC_CI_CHECK_MODULE has no parameter.
Method INIT_R3TR_KEYS_TO_CHECK on class CL_SATC_CI_CHECK_MODULE has no exception.

Method PROCESS_CI_FAILURES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_ERRORS	Call by reference	☐	Type reference (TYPE)	CX_SATC_CI_CHECK_ERRORS=>TY_CAUGHT_EXCEPTIONS			20130325

Method PROCESS_CI_FAILURES on class CL_SATC_CI_CHECK_MODULE has no exception.

Method PROCESS_CI_FINDINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FINDINGS	Call by reference	☐	Type reference (TYPE)	SCIT_REST			20130528

Method PROCESS_CI_FINDINGS on class CL_SATC_CI_CHECK_MODULE has no exception.

Method REMOVE_WRAPPING_EXCEPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT			20120515
2	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CX_ROOT			20120515

Method REMOVE_WRAPPING_EXCEPTIONS on class CL_SATC_CI_CHECK_MODULE has no exception.

Method RUN_CHECKS_AND_PROCESS_RESULTS Signature

Method RUN_CHECKS_AND_PROCESS_RESULTS on class CL_SATC_CI_CHECK_MODULE has no parameter.
Method RUN_CHECKS_AND_PROCESS_RESULTS on class CL_SATC_CI_CHECK_MODULE has no exception.

Method SET_CHECK_MODULE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT			20120209
2	Importing	I_EXEC_PHASE	Call by reference	☐	Type reference (TYPE)	CX_SATC_CI_CHECK_ERRORS=>TY_EXECUTION_PHASE			20120515
3	Importing	I_MODULE_ID	Call by reference	☐	Type reference (TYPE)	SATC_D_ID			20120216
4	Importing	I_R3TR_KEY	Call by reference	☐	Type reference (TYPE)	SATC_S_R3TR_KEY			20120209

Method SET_CHECK_MODULE_EXCEPTION on class CL_SATC_CI_CHECK_MODULE has no exception.

Method SET_EXECUTION_ABORTED Signature

Method SET_EXECUTION_ABORTED on class CL_SATC_CI_CHECK_MODULE has no parameter.
Method SET_EXECUTION_ABORTED on class CL_SATC_CI_CHECK_MODULE has no exception.

Method SET_PREREQUISITE_NOT_MET Signature

Method SET_PREREQUISITE_NOT_MET on class CL_SATC_CI_CHECK_MODULE has no parameter.
Method SET_PREREQUISITE_NOT_MET on class CL_SATC_CI_CHECK_MODULE has no exception.

Method WRITE_EXCEPTION_TO_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT			20120515
2	Importing	I_R3TR_KEY	Call by reference	☐	Type reference (TYPE)	SATC_S_R3TR_KEY			20120515

Method WRITE_EXCEPTION_TO_LOG on class CL_SATC_CI_CHECK_MODULE has no exception.

History

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