SAP ABAP Class CL_ODQ_CORE_SERVICE (Core Services 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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ODQ_BASE	Base Types and Base Constants for Operational Delta Queue	20091001
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ODQ_CORE_WRITER	Write Handle for Core Service of Operational Delta Queue	20091112
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ODQ_DELTA_CONSUMER	Recipient for Delta Information	20091001
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ODQ_ON_COMMIT_HANDLER	Interface for ON COMMIT/ROLLBACK	20091001

Properties

Class	CL_ODQ_CORE_SERVICE
Short Description	Core Services 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	20091001	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)
2	CL_ODQ_CORE_SERVICE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_ODQ_TSN	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ODQ_BASE	☐	☐	Base Types and Base Constants for Operational Delta Queue	20091001
2	IF_ODQ_CORE_WRITER	☐	☐	Write Handle for Core Service of Operational Delta Queue	20091112
3	IF_ODQ_DELTA_CONSUMER	☐	☐	Recipient for Delta Information	20091001
4	IF_ODQ_ON_COMMIT_HANDLER	☐	☐	Interface for ON COMMIT/ROLLBACK	20091001

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ODQ_DELTA_REQUEST_TASK	☐	20091124	Delta Request

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_MAX_QUEUEKEY_BLOCKSIZE	Constant	Private	☐	Type reference (TYPE)	I	50		20100113
2	C_MAX_UNIT_SIZE	Static Attribute	Public	☐	Type reference (TYPE)	I	50000000	Maximum Unit Size in Bytes	20120404
3	C_STATE	Constant	Private	☐	See coding				20091001
4	PR_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ODQ_CORE_SERVICE			20091001
5	PS_TSNLOG	Instance attribute	Private	☐	Type reference (TYPE)	ODQTSNLOG			20091001
6	PTH_QUEUES	Instance attribute	Private	☐	Type reference (TYPE)	TTH_QUEUES			20091001
7	PTH_QUEUESTATES	Instance attribute	Private	☐	See coding				20091001
8	PT_DATA_STATISTICS	Instance attribute	Private	☐	Type reference (TYPE)	ODQ_T_DATA_STATISTICS		Statistics For Updated Data	20110527
9	PT_QUEUES_OC	Instance attribute	Private	☐	Type reference (TYPE)	TT_QUEUES			20100112
10	PT_QUEUE_UNITS	Instance attribute	Private	☐	Type reference (TYPE)	TT_QUEUE_UNITS			20091001
11	PT_QUEUE_UNITS_V1	Instance attribute	Private	☐	Type reference (TYPE)	TT_QUEUE_UNITS			20091001
12	PT_QUEUE_UNITS_V2	Instance attribute	Private	☐	Type reference (TYPE)	TT_QUEUE_UNITS			20091001
13	PT_QUEUE_UNITS_V3	Instance attribute	Private	☐	Type reference (TYPE)	TT_QUEUE_UNITS			20091001
14	P_STATE	Instance attribute	Private	☐	Type reference (TYPE)	I			20091001
15	P_TSN_REQUIRED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20091001
16	P_UNITNO	Instance attribute	Private	☐	Type reference (TYPE)	TS_QUEUE_UNIT-UNITNO			20091001
17	P_WAITTIME	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL			20091208

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_QUEUE	Instance method	Public	Method		20091001
2	ACTIVATE_QUEUES	Instance method	Public	Method		20091001
3	CLEANUP_DATA	Instance method	Private	Method		20091001
4	CLEANUP_TSN	Instance method	Private	Method		20100113
5	COLLECT_STATISTICS	Instance method	Private	Method		20110527
6	COMMIT	Static method	Public	Method		20091001
7	DEACTIVATE_QUEUES	Instance method	Public	Method		20091001
8	DELETE_BUCKET	Static method	Public	Method		20091001
9	DELETE_FROM_TSNLOG	Static method	Public	Method		20091001
10	DELETE_QUEUES	Instance method	Public	Method		20091001
11	DELETE_QUEUE_DATA	Instance method	Public	Method		20091001
12	DEQUEUE_QUEUES	Instance method	Public	Method		20110401
13	ENQUEUE_QUEUES	Instance method	Public	Method	Lock List of Queues	20110401
14	FLUSH	Instance method	Private	Method		20091001
15	GET_INSTANCE	Static method	Public	Method		20091001
16	GET_QUEUEKEYS	Instance method	Public	Method		20091117
17	GET_QUEUESTATE_REF	Instance method	Private	Method		20091001
18	GET_TID	Instance method	Private	Method		20091001
19	GET_TSN	Instance method	Public	Method		20091124
20	NOP	Static method	Public	Method	Dummy Method for Module Tests	20100111
21	ROLLBACK	Static method	Public	Method		20091118
22	WAIT_FOR_PENDING_TRANSACTIONS	Instance method	Public	Method		20091001
23	WRITE_INTERNAL	Instance method	Public	Method		20091001
24	WRITE_UNIT_ON_COMMIT	Instance method	Private	Method		20100112

Events

Class CL_ODQ_CORE_SERVICE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TSX_DELETE_UNIT	Public	See coding			20091001	BEGIN OF tsx_delete_unit, tsn TYPE odq_tsn, sum_lines TYPE i, count_rows TYPE i, thx_queue_tid_lists TYPE HASHED TABLE OF tsx_queue_tid_list WITH UNIQUE KEY modelname queuename, END OF tsx_delete_unit
2	TSX_QUEUE_TID_LIST	Public	See coding			20091001	BEGIN OF tsx_queue_tid_list, modelname TYPE odq_modelname, queuename TYPE odq_queuename, t_tids TYPE STANDARD TABLE OF odq_tid WITH KEY table_line, END OF tsx_queue_tid_list
3	TS_DATA_STATISTIC	Public	See coding		Statistics For Updated Data	20110527	ts_data_statistic TYPE LINE OF tt_data_statistics
4	TS_QUEUE	Private	See coding			20091001	BEGIN OF ts_queue, modelname TYPE odq_modelname, queuename TYPE odq_queuename, update_level TYPE i, max_lines TYPE i, r_data TYPE REF TO data, END OF ts_queue
5	TS_QUEUE_UNIT	Public	Type reference (TYPE)	ODQDATA		20091001
6	TTH_QUEUES	Private	See coding			20091001	tth_queues TYPE HASHED TABLE OF ts_queue WITH UNIQUE KEY modelname queuename
7	TTX_DELETE_UNITS	Public	See coding			20091001	ttx_delete_units TYPE STANDARD TABLE OF tsx_delete_unit WITH DEFAULT KEY
8	TT_DATA_STATISTICS	Public	Type reference (TYPE)	ODQ_T_DATA_STATISTICS	Statistics For Updated Data	20110527
9	TT_QUEUES	Private	See coding			20100112	tt_queues TYPE STANDARD TABLE OF ts_queue WITH DEFAULT KEY
10	TT_QUEUE_UNITS	Public	See coding			20091001	tt_queue_units TYPE STANDARD TABLE OF ts_queue_unit WITH DEFAULT KEY
11	T_MODELNAME	Public	Type reference (TYPE)	ODQ_MODELNAME		20091126
12	T_QUEUENAME	Public	Type reference (TYPE)	ODQ_QUEUENAME		20091001

Method Signatures

Method ACTIVATE_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MODELNAME	Call by reference	☐	Type reference (TYPE)	ODQ_MODELNAME		Queue-Modell	20091110
2	Importing	I_QUEUENAME	Call by reference	☐	Type reference (TYPE)	ODQ_QUEUENAME		Queue-Name	20091001

#	Exception	Resumable	Description	Created on
1	CX_ODQ_INPUT_INVALID	☐		20091001
2	CX_ODQ_TIMEOUT	☐		20091001

Method ACTIVATE_QUEUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUEKEYS	Call by reference	☐	Type reference (TYPE)	ODQ_T_QUEUEKEYS		Liste von gesperrten Queue-Schlüsseln	20130114
2	Importing	IR_LOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ODQ_LOG		Protokoll-Handle für Operationale DeltaQueue	20091211
3	Importing	IT_QUEUEKEYS	Call by reference	☐	Type reference (TYPE)	ODQ_T_QUEUEKEYS		Liste von Queue-Schlüsseln	20091110
4	Importing	I_ONLY_DEQUEUE	Call by reference	☑	Type reference (TYPE)	ODQ_BOOLEAN		Queue-Schlüsseln nur entsperren	20130114

#	Exception	Resumable	Description	Created on
1	CX_ODQ_INPUT_INVALID	☐		20091001
2	CX_ODQ_TIMEOUT	☐		20091001

Method CLEANUP_DATA Signature

Method CLEANUP_DATA on class CL_ODQ_CORE_SERVICE has no parameter.
Method CLEANUP_DATA on class CL_ODQ_CORE_SERVICE has no exception.

Method CLEANUP_TSN Signature

Method CLEANUP_TSN on class CL_ODQ_CORE_SERVICE has no parameter.
Method CLEANUP_TSN on class CL_ODQ_CORE_SERVICE has no exception.

Method COLLECT_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUEUE_UNITS	Call by reference	☐	Type reference (TYPE)	TT_QUEUE_UNITS			20110527
2	Importing	I_UPDATE_LEVEL	Call by reference	☑	Type reference (TYPE)	I			20110527

Method COLLECT_STATISTICS on class CL_ODQ_CORE_SERVICE has no exception.

Method COMMIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA_STATISTICS	Call by reference	☐	Type reference (TYPE)	CL_ODQ_CORE_SERVICE=>TT_DATA_STATISTICS		Statistik über fortgeschriebene Daten	20110527

Method COMMIT on class CL_ODQ_CORE_SERVICE has no exception.

Method DEACTIVATE_QUEUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_LOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ODQ_LOG		Protokoll-Handle für Operationale DeltaQueue	20091211
2	Importing	IT_QUEUEKEYS	Call by reference	☐	Type reference (TYPE)	ODQ_T_QUEUEKEYS		Liste von Queue-Schlüsseln	20091117
3	Importing	I_ALL	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20091001
4	Importing	I_SKIP_ENQUEUE	Call by reference	☑	Type reference (TYPE)	ODQ_BOOLEAN		Boolsches Kennzeichen	20091117

Method DEACTIVATE_QUEUES on class CL_ODQ_CORE_SERVICE has no exception.

Method DELETE_BUCKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITX_DELETE_UNITS	Call by reference	☐	Type reference (TYPE)	TTX_DELETE_UNITS			20091001
2	Importing	I_SIMULATE	Call by reference	☑	Type reference (TYPE)	ODQ_BOOLEAN		Löschen nur simulieren	20100201
3	Returning	RR_RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	IF_ODQ_RESPONSE		Task zur (asynchronen Abarbeitung)	20100202

Method DELETE_BUCKET on class CL_ODQ_CORE_SERVICE has no exception.

Method DELETE_FROM_TSNLOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TSN_RANGES	Call by reference	☐	Type reference (TYPE)	CL_ODQ_TSN=>TT_TSN_RANGES			20091001
2	Importing	I_NO_COMMIT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20091001
3	Importing	I_SIMULATE	Call by reference	☑	Type reference (TYPE)	ODQ_BOOLEAN		Löschen nur simulieren	20100201
4	Returning	R_COUNT	Value transfer	☐	Type reference (TYPE)	I			20100202

Method DELETE_FROM_TSNLOG on class CL_ODQ_CORE_SERVICE has no exception.

Method DELETE_QUEUES 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)	ODQ_T_QUEUEKEYS		Liste von Queue-Schlüsseln	20091117
2	Importing	I_ALL	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20091001
3	Importing	I_ALSO_ACTIVE_QUEUES	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20091001
4	Importing	I_DEGREE_OF_PARALLELISM	Call by reference	☑	Type reference (TYPE)	I			20091001

Method DELETE_QUEUES on class CL_ODQ_CORE_SERVICE has no exception.

Method DELETE_QUEUE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_UNIT_STATISTICS	Call by reference	☐	Type reference (TYPE)	ODQ_T_UNIT_STATISTICS		Queue-Statistik (z.B. für Löschen)	20100202
2	Exporting	E_COUNT_TSN	Call by reference	☐	Type reference (TYPE)	ODQ_COUNT_TSN		Anzahl Transaktionen (TSNs)	20100202
3	Importing	IT_QUEUEKEYS	Call by reference	☑	Type reference (TYPE)	ODQ_T_QUEUEKEYS		Liste von Queue-Schlüsseln	20091117
4	Importing	I_DEGREE_OF_PARALLELISM	Call by reference	☑	Type reference (TYPE)	I		Boolsches Kennzeichen	20091214
5	Importing	I_SIMULATE	Call by reference	☑	Type reference (TYPE)	ODQ_BOOLEAN		Löschen nur simulieren	20100201
6	Importing	I_TSN_HIGH	Call by reference	☑	Type reference (TYPE)	ODQ_TSN		Fortlaufende Transaktionsnummer (TSN)	20091001

#	Exception	Resumable	Description	Created on
1	CX_ODQ_PROCESS_ERROR	☐	Verarbeitungsfehler	20091214

Method DEQUEUE_QUEUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_QUEUEKEYS	Call by reference	☐	Type reference (TYPE)	ODQ_T_QUEUEKEYS		Liste von Queue-Schlüsseln	20110401

#	Exception	Resumable	Description	Created on
1	CX_ODQ_TIMEOUT	☐	Zeitlimit überschritten	20110401

Method ENQUEUE_QUEUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_QUEUEKEYS	Call by reference	☐	Type reference (TYPE)	ODQ_T_QUEUEKEYS		Liste von Queue-Schlüsseln	20110401
2	Importing	I_ENQMODE	Call by reference	☑	Type reference (TYPE)	CL_ODQ_TSN=>T_ENQMODE			20110712
3	Importing	I_NO_WAIT	Call by reference	☑	Type reference (TYPE)	ODQ_BOOLEAN		Boolsches Kennzeichen	20110405

#	Exception	Resumable	Description	Created on
1	CX_ODQ_TIMEOUT	☐	Zeitlimit überschritten	20110401

Method FLUSH 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			20091001
2	Importing	I_MODELNAME	Call by reference	☐	Type reference (TYPE)	ODQ_MODELNAME		Queue-Modell	20091110
3	Importing	I_QUEUENAME	Call by reference	☐	Type reference (TYPE)	ODQ_QUEUENAME			20091001
4	Importing	I_UPDATE_LEVEL	Call by reference	☑	Type reference (TYPE)	I			20091001

Method FLUSH on class CL_ODQ_CORE_SERVICE has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ODQ_CORE_SERVICE			20091001

Method GET_INSTANCE on class CL_ODQ_CORE_SERVICE has no exception.

Method GET_QUEUEKEYS 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)	ODQ_T_QUEUEKEYS		Liste von Queue-Schlüsseln	20091117
2	Importing	I_ALL	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20091117
3	Importing	I_QUEUESTATE	Call by reference	☑	Type reference (TYPE)	IF_ODQ_BASE=>T_QUEUESTATE			20091117
4	Returning	RT_QUEUEKEYS	Value transfer	☐	Type reference (TYPE)	ODQ_T_QUEUEKEYS		Liste von Queue-Schlüsseln	20091117

Method GET_QUEUEKEYS on class CL_ODQ_CORE_SERVICE has no exception.

Method GET_QUEUESTATE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MODELNAME	Call by reference	☐	Type reference (TYPE)	ODQ_MODELNAME		Queue-Modell	20091130
2	Importing	I_QUEUENAME	Call by reference	☐	Type reference (TYPE)	ODQ_QUEUENAME		Queue-Name	20091001
3	Returning	RR_QUEUESTATE	Value transfer	☐	Object reference (TYPE REF TO)	IF_ODQ_BASE=>TS_QUEUESTATE			20091001

Method GET_QUEUESTATE_REF on class CL_ODQ_CORE_SERVICE has no exception.

Method GET_TID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TID	Value transfer	☐	Type reference (TYPE)	ODQ_TID			20091001

Method GET_TID on class CL_ODQ_CORE_SERVICE has no exception.

Method GET_TSN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TSN	Value transfer	☐	Type reference (TYPE)	ODQ_TSN		Fortlaufende Transaktionsnummer (TSN)	20091124

Method GET_TSN on class CL_ODQ_CORE_SERVICE has no exception.

Method NOP Signature

Method NOP on class CL_ODQ_CORE_SERVICE has no parameter.
Method NOP on class CL_ODQ_CORE_SERVICE has no exception.

Method ROLLBACK Signature

Method ROLLBACK on class CL_ODQ_CORE_SERVICE has no parameter.
Method ROLLBACK on class CL_ODQ_CORE_SERVICE has no exception.

Method WAIT_FOR_PENDING_TRANSACTIONS Signature

Method WAIT_FOR_PENDING_TRANSACTIONS on class CL_ODQ_CORE_SERVICE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ODQ_TIMEOUT	☐		20091001

Method WRITE_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUEUE_UNITS	Call by reference	☐	Type reference (TYPE)	TT_QUEUE_UNITS			20091001

Method WRITE_INTERNAL on class CL_ODQ_CORE_SERVICE has no exception.

Method WRITE_UNIT_ON_COMMIT 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			20100112
2	Importing	I_COMMIT_LEVEL	Call by reference	☑	Type reference (TYPE)	I			20100112
3	Importing	I_MODELNAME	Call by reference	☐	Type reference (TYPE)	ODQ_MODELNAME		Queue-Modell	20100112
4	Importing	I_QUEUENAME	Call by reference	☐	Type reference (TYPE)	ODQ_QUEUENAME		Queue-Name	20100112
5	Importing	I_UPDATE_LEVEL	Call by reference	☑	Type reference (TYPE)	I			20100112
6	Returning	R_TID	Value transfer	☐	Type reference (TYPE)	ODQ_TID		Eindeutige Transaktions-Id	20100113

Method WRITE_UNIT_ON_COMMIT on class CL_ODQ_CORE_SERVICE has no exception.

History

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