SAP ABAP Class CL_ODQ_UTILITIES (Utilities/Methods for Operational Delta Queue)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-BW-SRV (Application Component) BW Generation Tool and Set Object
     ⤷ SODQS (Package) Operational Delta Queue Services

Properties

Class	CL_ODQ_UTILITIES
Short Description	Utilities/Methods for Operational Delta Queue
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	SODQ
Program status
Category	0
Package	SODQS	Operational Delta Queue Services
Created	20090922	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	CL_ABAP_STRUCTDESCR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_ODQ_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	IF_ODQ_CONSTANTS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	IF_ODQ_LOG	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ODQ_UTILITIES has no interface implemented.

Friends

Class CL_ODQ_UTILITIES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_BASXML_SIGNATURE	Constant	Private	☐	See coding		'42584D4C3F03564552'		20091130
2	C_BASXML_SIGNATURE_LENGTH	Constant	Private	☐	Type reference (TYPE)	I	9		20091130
3	C_BYTELEN_LENGTH	Constant	Private	☐	Type reference (TYPE)	I	4		20120918
4	C_COMPRESSION	Constant	Public	☐	See coding				20100205
5	C_DIRECTION	Constant	Public	☐	See coding				20090929
6	C_ENCODING	Constant	Private	☐	See coding				20120918
7	C_FIELDNAME	Constant	Public	☐	See coding				20120511
8	C_FRAGMENT_LINES_THRESHOLD	Constant	Private	☐	Type reference (TYPE)	I	5000		20120918
9	C_MAX_FRAGMENT_MSIZE	Constant	Private	☐	Type reference (TYPE)	I	100000000		20120918
10	C_MAX_WAITTIME	Constant	Public	☐	Type reference (TYPE)	TIMESTAMPL	'2147483647.9999999'		20090922
11	C_MAX_WAIT_CYCLETIME	Constant	Private	☐	Type reference (TYPE)	I	5		20090922
12	C_MAX_XSTRING_LENGTH	Constant	Private	☐	Type reference (TYPE)	I	2145386496		20120918
13	C_MSSTATE	Constant	Private	☐	See coding				20110218
14	C_OPCODE	Constant	Private	☐	See coding				20090922
15	C_SAFETY_FACTOR	Constant	Private	☐	Type reference (TYPE)	F	'1.0625'		20120918
16	C_SERVICE	Constant	Private	☐	See coding				20090922
17	C_WPBOOL	Constant	Private	☐	See coding				20110228
18	C_WPSTATUS	Constant	Private	☐	See coding				20091001
19	C_WPTYPE	Constant	Private	☐	See coding				20091001
20	P_ISOLATION	Static Attribute	Private	☐	Type reference (TYPE)	I			20100114
21	P_NOCOMPRESS	Static Attribute	Private	☐	Type reference (TYPE)	ODQ_BOOLEAN		Boolean Flag	20091130

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CSEQUENCE_TO_MESSAGE	Static method	Public	Method		20110629
2	EXCEPTION_TO_TEXT	Static method	Public	Method	Convert Exception to Text (and Populate SYST Fields)	20091208
3	GET_EXCEPTION_BINDINGS	Static method	Public	Method		20090929
4	GET_FALLBACK_DATADESCR	Static method	Private	Method		20110809
5	GET_FALLBACK_TABLEDESCR	Static method	Private	Method		20110809
6	GET_PARAMETER_BINDINGS	Static method	Public	Method		20090929
7	GET_PROCESS_INFO	Static method	Public	Method		20090922
8	GET_PROCESS_STATISTIC	Static method	Public	Method		20091126
9	GET_SERVERS	Static method	Public	Method		20090929
10	GET_STRUCTDESCR_COMPONENTS	Static method	Public	Method		20101207
11	PROFILE_GET_VALUE	Static method	Public	Method	Set current value of profile parameter	20120918
12	QUEUEKEYS_TO_SQLCOND	Static method	Public	Method		20091123
13	RESET_ISOLATION	Static method	Public	Method		20100114
14	SET_ISOLATION	Static method	Public	Method		20100114
15	SYNCHRONIZE_SERVER	Static method	Public	Method		20090922
16	UNWRAP_DATA	Static method	Public	Method		20091119
17	UNWRAP_OBJECT	Static method	Public	Method		20091125
18	WAIT	Static method	Public	Method		20090922
19	WRAP_DATA	Static method	Public	Method		20091119
20	WRAP_OBJECT	Static method	Public	Method		20091125

Events

Class CL_ODQ_UTILITIES has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_MESSAGE_VARIABLES	Public	See coding			20110629	BEGIN OF ts_message_variables, msgv1 TYPE sy-msgv1, msgv2 TYPE sy-msgv2, msgv3 TYPE sy-msgv3, msgv4 TYPE sy-msgv4, END OF ts_message_variables
2	TS_PROCESS_INFO	Public	Type reference (TYPE)	ODQ_S_PROCESS_INFO	Process Information	20100504
3	TS_SERVER	Public	See coding			20091001	BEGIN OF ts_server, name TYPE t_servername, all TYPE ts_wpcount, free TYPE ts_wpcount, END OF ts_server
4	TS_STATISTIC	Public	Type reference (TYPE)	ODQ_S_STATISTIC	Statistical Data for Transaction/Replication	20100504
5	TS_WPCOUNT	Public	See coding			20091001	BEGIN OF ts_wpcount, btc TYPE i, dia TYPE i, enq TYPE i, spo TYPE i, upd TYPE i, upd2 TYPE i, END OF ts_wpcount
6	TT_QUEUEKEYS	Public	Type reference (TYPE)	ODQ_T_QUEUEKEYS	List of Queue Keys	20100504
7	TT_QUEUESTATES	Public	Type reference (TYPE)	ODQ_T_QUEUESTATES	Queue Status	20100504
8	TT_SERVERNAMES	Public	See coding		Application Server Name	20090929	tt_servernames TYPE STANDARD TABLE OF t_servername WITH KEY table_line
9	TT_SERVERS	Public	See coding			20091001	tt_servers TYPE STANDARD TABLE OF ts_server WITH DEFAULT KEY
10	T_COMPRESSION	Public	Type reference (TYPE)	ODQ_DATAFORMAT		20100205
11	T_DIRECTION	Public	See coding			20090929	t_direction TYPE c LENGTH 1
12	T_RAWSIZE	Public	Type reference (TYPE)	ODQ_RAWSIZE	Size in Bytes	20130124
13	T_SERVERNAME	Public	Type reference (TYPE)	MSNAME2	Application Server Name	20090929
14	T_THBITVALUE	Private	See coding			20090922	t_thbitvalue TYPE x LENGTH 1
15	T_THMSSTATE	Private	Type reference (TYPE)	MSSTATE		20110218
16	T_THOPCODE	Private	See coding			20090922	t_thopcode TYPE x LENGTH 1
17	T_WAITTIME	Public	Type reference (TYPE)	TIMESTAMPL		20090922
18	T_WPBOOL	Private	See coding			20110228	t_wpbool TYPE x LENGTH 1

Method Signatures

Method CSEQUENCE_TO_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INPUT	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20110629
2	Returning	RS_MESSAGE_VARIABLES	Value transfer	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>TS_MESSAGE_VARIABLES			20110629

Method CSEQUENCE_TO_MESSAGE on class CL_ODQ_UTILITIES has no exception.

Method EXCEPTION_TO_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IRX_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstrakte Oberklasse aller globalen Exceptions	20091208
2	Returning	R_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20091208

Method EXCEPTION_TO_TEXT on class CL_ODQ_UTILITIES has no exception.

Method GET_EXCEPTION_BINDINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLASSNAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Objekttypname	20090929
2	Importing	I_METHODNAME	Call by reference	☐	Type reference (TYPE)	ABAP_METHNAME			20090929
3	Returning	RTH_EXCEPTION_BINDINGS	Value transfer	☐	Type reference (TYPE)	ABAP_EXCPBIND_TAB			20090929

#	Exception	Resumable	Description	Created on
1	CX_ODQ_INPUT_INVALID	☐	Ungültige(r) Parameterwert(e)	20090929

Method GET_FALLBACK_DATADESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DATADESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Run Time Type Services	20110809
2	Returning	RR_DATADESCR	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Run Time Type Services	20110809

Method GET_FALLBACK_DATADESCR on class CL_ODQ_UTILITIES has no exception.

Method GET_FALLBACK_TABLEDESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20110809
2	Returning	RR_TABLEDESCR	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_TABLEDESCR		Run Time Type Services	20110809

Method GET_FALLBACK_TABLEDESCR on class CL_ODQ_UTILITIES has no exception.

Method GET_PARAMETER_BINDINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLASSNAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Objekttypname	20090929
2	Importing	I_DIRECTION	Call by reference	☑	Type reference (TYPE)	CL_ODQ_UTILITIES=>T_DIRECTION			20090929
3	Importing	I_METHODNAME	Call by reference	☐	Type reference (TYPE)	SEOMTDNAME		Name einer Methode	20090929
4	Importing	I_SKIP_OPTIONAL	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20091001
5	Returning	RTH_PARAMETER_BINDINGS	Value transfer	☐	Type reference (TYPE)	ABAP_PARMBIND_TAB			20090929

#	Exception	Resumable	Description	Created on
1	CX_ODQ_INPUT_INVALID	☐	Ungültige(r) Parameterwert(e)	20090929

Method GET_PROCESS_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_PROCESS_INFO	Value transfer	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>TS_PROCESS_INFO		Prozessinformationen	20090922

Method GET_PROCESS_INFO on class CL_ODQ_UTILITIES has no exception.

Method GET_PROCESS_STATISTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_PROCESS_STATISTIC	Value transfer	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>TS_STATISTIC		Statistikdaten zur Transaktion/Replikation	20091214

Method GET_PROCESS_STATISTIC on class CL_ODQ_UTILITIES has no exception.

Method GET_SERVERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_AVAILABILITY	Call by reference	☑	Type reference (TYPE)	IF_ODQ_CONSTANTS=>T_BOOLEAN			20110114
2	Importing	I_WITH_WPINFO	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20091001
3	Returning	RT_SERVERS	Value transfer	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>TT_SERVERS		Liste der Applikationsserver	20091001

Method GET_SERVERS on class CL_ODQ_UTILITIES has no exception.

Method GET_STRUCTDESCR_COMPONENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Run Time Type Services	20101207
2	Returning	RT_COMPONENTS	Value transfer	☐	Type reference (TYPE)	CL_ABAP_STRUCTDESCR=>COMPONENT_TABLE		Komponentenbeschreibungstabelle	20101207

Method GET_STRUCTDESCR_COMPONENTS on class CL_ODQ_UTILITIES has no exception.

Method PROFILE_GET_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20120918
2	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20120918

Method PROFILE_GET_VALUE on class CL_ODQ_UTILITIES has no exception.

Method QUEUEKEYS_TO_SQLCOND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUEUEKEYS	Call by reference	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>TT_QUEUEKEYS		Liste von Queue-Schlüsseln	20091123
2	Importing	I_TABALIAS	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20091123
3	Returning	R_SQLCOND	Value transfer	☐	Type reference (TYPE)	STRING			20091123

Method QUEUEKEYS_TO_SQLCOND on class CL_ODQ_UTILITIES has no exception.

Method RESET_ISOLATION Signature

Method RESET_ISOLATION on class CL_ODQ_UTILITIES has no parameter.
Method RESET_ISOLATION on class CL_ODQ_UTILITIES has no exception.

Method SET_ISOLATION Signature

Method SET_ISOLATION on class CL_ODQ_UTILITIES has no parameter.
Method SET_ISOLATION on class CL_ODQ_UTILITIES has no exception.

Method SYNCHRONIZE_SERVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUEUESTATES	Call by reference	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>TT_QUEUESTATES		Queue-Status	20090922

Method SYNCHRONIZE_SERVER on class CL_ODQ_UTILITIES has no exception.

Method UNWRAP_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20091119
2	Importing	I_APPEND	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20091119
3	Importing	I_COMPRESSION	Call by reference	☑	Type reference (TYPE)	CL_ODQ_UTILITIES=>T_COMPRESSION			20100525
4	Importing	I_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20091119

#	Exception	Resumable	Description	Created on
1	CX_ODQ_INPUT_INVALID	☐		20091119

Method UNWRAP_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20091125
2	Returning	RR_SERIALIZABLE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SERIALIZABLE_OBJECT		Serialisierbares Objekt	20091125

#	Exception	Resumable	Description	Created on
1	CX_ODQ_INPUT_INVALID	☐		20091125

Method WAIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SECONDS	Call by reference	☑	Type reference (TYPE)	NUMERIC			20090922

Method WAIT on class CL_ODQ_UTILITIES has no exception.

Method WRAP_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_COMPRESSION	Call by reference	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>T_COMPRESSION		Compression method	20100525
2	Exporting	E_RAWSIZE	Call by reference	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>T_RAWSIZE		Raw size in Bytes	20130124
3	Exporting	E_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20091119
4	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20091119
5	Importing	I_COMPRESSION	Call by reference	☐	Type reference (TYPE)	CL_ODQ_UTILITIES=>T_COMPRESSION	CL_ODQ_UTILITIES=>C_COMPRESSION-GZIPPED_BASXML		20100205

#	Exception	Resumable	Description	Created on
1	CX_ODQ_INPUT_INVALID	☐	Ungültige(r) Parameterwert(e)	20110720

Method WRAP_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_SERIALIZABLE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SERIALIZABLE_OBJECT		Serialisierbares Objekt	20091125
2	Returning	R_XDATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20091125

Method WRAP_OBJECT on class CL_ODQ_UTILITIES has no exception.

History

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