SAP ABAP Class CL_DBA_STORED_PROCEDURE (DBA-DBH: Stored Procedure Helper)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB (Application Component) Database Interface, Database Platforms
     ⤷ SDBA_BACKEND (Package) DBA Cockpit: Backend Infrastructure

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_DB6_STORED_PROCEDURE	DB6-DBH: Stored Procedure Helper	20100811
2	Inheritance (c INHERITING FROM c_ref)	CL_SYB_STORED_PROCEDURE	SYB-DBH: Stored Procedure Helper	20100811

Properties

Class	CL_DBA_STORED_PROCEDURE
Short Description	DBA-DBH: Stored Procedure Helper
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SDBA_BACKEND	DBA Cockpit: Backend Infrastructure
Created	20100811	SAP
Last change	20130531	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)

Interfaces

Class CL_DBA_STORED_PROCEDURE has no interface implemented.

Friends

Class CL_DBA_STORED_PROCEDURE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BODY	Instance attribute	Protected	☐	Type reference (TYPE)	DB6_DBH_SRC			20100811
2	CHANGED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicates if SP was modified	20100811
3	COLLECT_HOST_PARAM_NAME	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100811
4	COLLECT_HOST_PARAM_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100811
5	COLLECT_MODE_PARAM_NAME	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100811
6	COLLECT_MODE_PARAM_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100811
7	COLLECT_SID_PARAM_NAME	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100811
8	COLLECT_SID_PARAM_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100811
9	COLLECT_USER_PARAM_NAME	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100811
10	COLLECT_USER_PARAM_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100811
11	CO_COLLECT_MODE_SCHEDULED	Constant	Public	☐	Type reference (TYPE)	STRING	'S'		20100811
12	CO_COLLECT_MODE_USER	Constant	Public	☐	Type reference (TYPE)	STRING	'U'		20100811
13	CO_GEN_MODE_DEFAULTS	Constant	Public	☐	Type reference (TYPE)	I	2	Generation Mode - Defaults	20100811
14	CO_GEN_MODE_NORMAL	Constant	Public	☐	Type reference (TYPE)	I	1	Generation Mode - Normal	20100811
15	CURSORS	Instance attribute	Protected	☐	Type reference (TYPE)	DB6_DBH_SRC			20100811
16	GEN_MODE	Instance attribute	Protected	☐	Type reference (TYPE)	I	1	Generation Mode	20100811
17	HANDLERS	Instance attribute	Protected	☐	Type reference (TYPE)	DB6_DBH_SRC			20100811
18	INIT	Instance attribute	Protected	☐	Type reference (TYPE)	DB6_DBH_SRC			20100811
19	MV_SRC_AS_STRING	Instance attribute	Protected	☐	Type reference (TYPE)	STRING			20121113
20	PARAMETERS	Instance attribute	Protected	☐	Type reference (TYPE)	DB6_STP_PARAMETER_LIST			20100811
21	PHASE_CNT	Instance attribute	Protected	☐	Type reference (TYPE)	I	0	Phase Counter	20100811
22	SPECIFICNAME	Instance attribute	Protected	☐	Type reference (TYPE)	DB6_DBH_ROUTINE_NAME		DB6-DBH: Routine Name (UDF/SP)	20101014
23	SP_ID	Instance attribute	Public	☑	Type reference (TYPE)	DB6_DBH_ROUTINE_NAME			20100811
24	SRC	Instance attribute	Protected	☐	Type reference (TYPE)	DB6_DBH_SRC			20100811
25	SYS_REF	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_DB6_SYS			20120125
26	VARIABLES	Instance attribute	Protected	☐	Type reference (TYPE)	DB6_DBH_SRC			20100811

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BODY	Instance method	Public	Method	Add Source to Body	20100811
2	ADD_CURSOR	Instance method	Public	Method	Add Source to Body	20100811
3	ADD_HANDLER	Instance method	Public	Method	Add a Handler	20100811
4	ADD_INIT	Instance method	Public	Method	Add Initialization Actions	20100811
5	ADD_PARAMETER	Instance method	Public	Method	Add Parameter	20100811
6	ADD_PHASE	Instance method	Public	Method	Adds a Phase Comment	20100811
7	ADD_TRC	Instance method	Public	Method	Adds Code for Tracing	20100811
8	ADD_VARIABLE	Instance method	Public	Method	Add a Variable	20100811
9	CHECK_ROUTINE	Instance method	Public	Method	Check routine, if necessary create it	20100811
10	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100811
11	FINALIZE	Instance method	Public	Method	Finalize SP Code	20100811
12	GENERATE_SRC	Instance method	Public	Method	Generate Stored Procedure	20100811
13	GET_LAST_BODY	Instance method	Public	Method	Returns Last Line of Body	20100811
14	GET_SRC_AS_STRING	Instance method	Public	Method	Get source as String	20100811
15	GET_SRC_AS_TAB	Instance method	Public	Method	Get source as Table of String	20100811
16	MODIFY_LAST_BODY	Instance method	Public	Method	Modify the Last Line of the Body	20100811
17	NUM_PARAMETERS	Instance method	Public	Method	Returns the Number of Parameters	20100811
18	RESET_HANDLERS	Instance method	Public	Method	Reset the Default Handlers	20100811
19	SRC_AS_STRING	Instance method	Private	Method	Source as String	20100811

Events

Class CL_DBA_STORED_PROCEDURE has no event.

Types

Class CL_DBA_STORED_PROCEDURE has no local type.

Method Signatures

Method ADD_BODY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SRC_LINE	Value transfer	☐	Type reference (TYPE)	DB6_DBH_SRC_LINE		DB6-DBH: Source Line of Routine	20100811

Method ADD_BODY on class CL_DBA_STORED_PROCEDURE has no exception.

Method ADD_CURSOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SRC_LINE	Value transfer	☐	Type reference (TYPE)	DB6_DBH_SRC_LINE		DB6-DBH: Source Line of Routine	20100811

Method ADD_CURSOR on class CL_DBA_STORED_PROCEDURE has no exception.

Method ADD_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SRC_LINE	Value transfer	☐	Type reference (TYPE)	DB6_DBH_SRC_LINE		DB6-DBH: Source Line of Routine	20100811

Method ADD_HANDLER on class CL_DBA_STORED_PROCEDURE has no exception.

Method ADD_INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SRC_LINE	Call by reference	☐	Type reference (TYPE)	DB6_DBH_SRC_LINE		DB6-DBH: Source Line of Routine	20100811

Method ADD_INIT on class CL_DBA_STORED_PROCEDURE has no exception.

Method ADD_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20100811
2	Importing	DEFAULT_VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20100811
3	Importing	PARAM_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100811
4	Importing	PARAM_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20100811

Method ADD_PARAMETER on class CL_DBA_STORED_PROCEDURE has no exception.

Method ADD_PHASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PHASE	Call by reference	☐	Type reference (TYPE)	STRING			20100811

Method ADD_PHASE on class CL_DBA_STORED_PROCEDURE has no exception.

Method ADD_TRC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DIAG_LVL	Call by reference	☐	Type reference (TYPE)	DBA_DBH_VALUE		DBA-DBH: Key/Value for Configuration Table	20100811
2	Importing	DIAG_MSG	Call by reference	☐	Type reference (TYPE)	DB6_DBH_SRC_LINE		DB6-DBH: Source Line of Routine	20100811
3	Importing	INDENT	Call by reference	☑	Type reference (TYPE)	CLIKE			20100811
4	Importing	NO_EMPTY_LINE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100811

Method ADD_TRC on class CL_DBA_STORED_PROCEDURE has no exception.

Method ADD_VARIABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SRC_LINE	Value transfer	☐	Type reference (TYPE)	DB6_DBH_SRC_LINE		DB6-DBH: Source Line of Routine	20100811

Method ADD_VARIABLE on class CL_DBA_STORED_PROCEDURE has no exception.

Method CHECK_ROUTINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DBCNAME	Call by reference	☑	Type reference (TYPE)	DBCON_NAME		Logical name for a database connection	20100811
2	Importing	SYS_REF	Value transfer	☑	Object reference (TYPE REF TO)	CL_DB6_SYS		DB6: Remote System Administration	20100811

#	Exception	Resumable	Description	Created on
1	CX_DB6_ROOT	☐	DB6: Root Exception class	20100811

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PREFIX	Call by reference	☑	Type reference (TYPE)	DB6_DBH_ROUTINE_NAME		DB6-DBH: Routine Name (UDF/SP)	20100811
2	Importing	SAPTOOLS_WORKLOAD	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	DB6-DBH: SAPTOOLS Workload	20100811
3	Importing	SP_ID	Call by reference	☐	Type reference (TYPE)	DB6_DBH_ROUTINE_NAME		DB6-DBH: Routine Name (UDF/SP)	20100811
4	Importing	SYS_REF	Call by reference	☐	Object reference (TYPE REF TO)	CL_DB6_SYS		DB6: Remote System Administration	20100811

Method CONSTRUCTOR on class CL_DBA_STORED_PROCEDURE has no exception.

Method FINALIZE Signature

Method FINALIZE on class CL_DBA_STORED_PROCEDURE has no parameter.
Method FINALIZE on class CL_DBA_STORED_PROCEDURE has no exception.

Method GENERATE_SRC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GEN_MODE	Call by reference	☐	Type reference (TYPE)	I	CO_GEN_MODE_NORMAL		20100811

Method GENERATE_SRC on class CL_DBA_STORED_PROCEDURE has no exception.

Method GET_LAST_BODY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SRC_LINE	Value transfer	☐	Type reference (TYPE)	DB6_DBH_SRC_LINE		DB6-DBH: Source Line of Routine	20100811

Method GET_LAST_BODY on class CL_DBA_STORED_PROCEDURE has no exception.

Method GET_SRC_AS_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GEN_MODE	Call by reference	☐	Type reference (TYPE)	I	CO_GEN_MODE_NORMAL		20100811
2	Returning	SRC	Value transfer	☐	Type reference (TYPE)	STRING		DB6-DBH: Source of Stored Procedure	20100811

Method GET_SRC_AS_STRING on class CL_DBA_STORED_PROCEDURE has no exception.

Method GET_SRC_AS_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GEN_MODE	Call by reference	☐	Type reference (TYPE)	I	CO_GEN_MODE_NORMAL		20100811
2	Returning	SRC	Value transfer	☐	Type reference (TYPE)	DB6_DBH_SRC		DB6-DBH: Source of Stored Procedure	20100811

Method GET_SRC_AS_TAB on class CL_DBA_STORED_PROCEDURE has no exception.

Method MODIFY_LAST_BODY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SRC_LINE	Call by reference	☐	Type reference (TYPE)	DB6_DBH_SRC_LINE		DB6-DBH: Source Line of Routine	20100811

Method MODIFY_LAST_BODY on class CL_DBA_STORED_PROCEDURE has no exception.

Method NUM_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	I			20100811

Method NUM_PARAMETERS on class CL_DBA_STORED_PROCEDURE has no exception.

Method RESET_HANDLERS Signature

Method RESET_HANDLERS on class CL_DBA_STORED_PROCEDURE has no parameter.
Method RESET_HANDLERS on class CL_DBA_STORED_PROCEDURE has no exception.

Method SRC_AS_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SRC	Value transfer	☐	Type reference (TYPE)	STRING		DB6-DBH: Source of Stored Procedure	20100811

Method SRC_AS_STRING on class CL_DBA_STORED_PROCEDURE has no exception.

History

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