SAP ABAP Class CL_RSODP_BW_CURSOR (BW Cursor for ODP)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-WHM-DST (Application Component) Data Staging
     ⤷ RSODP (Package) Operational Data Provisioning (BW Part)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ODQ_EXTRACTOR	Extractor	20130215
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RODPS_ODP_CURSOR	Cursor	20130215

Properties

Class	CL_RSODP_BW_CURSOR
Short Description	BW Cursor for ODP
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	RSODP	Operational Data Provisioning (BW Part)
Created	20130215	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_RSTRAN_STAT	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_ODQ_QUEUE_MODEL	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_RODPS_ODP	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
6	RSD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ODQ_EXTRACTOR	☐	☐	Extractor	20130215
2	IF_RODPS_ODP_CURSOR	☐	☐	Cursor	20130215

Friends

Class CL_RSODP_BW_CURSOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_FILL_ODQ_FIELDS	Constant	Protected	☐	See coding				20130215
2	PR_ATTR_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA			20130701
3	PR_ODP_H	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_RODPS_HIER_ODP		ODP Metadata	20130701
4	PT_SEGMENT	Instance attribute	Private	☐	Type reference (TYPE)	TT_SEGMENT			20130701
5	PT_SEMANTIC_KEY	Instance attribute	Private	☐	Type reference (TYPE)	TT_SEMANTIC_KEY			20130701
6	P_DTP_AUX	Instance attribute	Protected	☐	See coding				20130215
7	P_EXTRACTION_MODE	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_EXTRACTION_MODE			20130215
8	P_FIELDNAME_LEAF	Instance attribute	Private	☐	Type reference (TYPE)	ODP_S_HIERARCHY_ELEMENT-FIELDNAME_ASC			20130701
9	P_FILL_ODQ_FIELDS	Instance attribute	Protected	☐	Type reference (TYPE)	T_FILL_ODQ_FIELDS			20130215
10	P_IS_CLOSED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20130215
11	P_MAXIMUM_ROWS	Instance attribute	Protected	☐	Type reference (TYPE)	I			20130215
12	P_OBJNM	Instance attribute	Protected	☐	Type reference (TYPE)	SOBJ_NAME			20130215
13	P_QUEUENAME	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_QUEUENAME			20130221
14	P_R_DATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA			20130215
15	P_R_LOG	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_ODQ_LOG			20130215
16	P_R_MOVE_TYPE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20130215
17	P_SIMULATION	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_BOOLEAN			20130215
18	P_SUBTYPE	Instance attribute	Protected	☐	Type reference (TYPE)	RSO_TLOGO_SUBTYPE			20130215
19	P_S_RECORDMODE	Instance attribute	Protected	☐	Type reference (TYPE)	TS_RECORDMODE			20130215
20	P_TH_RANGE	Instance attribute	Protected	☐	Type reference (TYPE)	RSBK_TH_RANGE		DTP: Selections for Source	20130215
21	P_TLOGO	Instance attribute	Protected	☐	Type reference (TYPE)	RSTLOGO			20130215
22	P_T_FIELD	Instance attribute	Protected	☐	Type reference (TYPE)	CL_RSTRAN_STAT=>TY_TX_RSBK		DTP: Field List for Runtime	20130215
23	P_T_PROJECTION	Instance attribute	Protected	☐	Type reference (TYPE)	IF_RODPS_ODP=>TT_FIELD_PROJECTIONS			20130215
24	P_T_PROJECTION_H	Instance attribute	Private	☐	Type reference (TYPE)	IF_RODPS_ODP=>TT_FIELD_PROJECTIONS			20130701

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_REQUID_TO_RANGE	Instance method	Protected	Method		20130215
2	CLOSE	Instance method	Protected	Method		20130215
3	CONSTRUCTOR	Instance method	Protected	Constructor		20130215
4	CREATE_TABLE	Instance method	Private	Method		20130701
5	FETCH_NEXT_PACKAGE	Instance method	Protected	Method		20130215
6	GET_DATA_REF	Instance method	Protected	Method		20130215
7	GET_INSTANCE	Static method	Public	Method		20130215
8	INIT_SEMANTIC_KEY	Instance method	Private	Method		20130701
9	MOVE_DATA	Instance method	Private	Method		20130701
10	MOVE_RSSH_TO_ODP	Instance method	Private	Method		20130701
11	ON_ERROR	Instance method	Protected	Method		20130215
12	OPEN_DEFERRED	Instance method	Protected	Method		20130215
13	TSN_TO_STRING	Static method	Public	Method		20130215
14	_FETCH_NEXT_PACKAGE	Instance method	Protected	Method		20130215
15	_OPEN_DEFERRED	Instance method	Protected	Method		20130215

Events

Class CL_RSODP_BW_CURSOR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TP_S_HEADERID	Private	See coding			20130701	BEGIN OF tp_s_headerid, objectid TYPE n LENGTH 10. INCLUDE TYPE odp_s_hierarchy_header_key AS s_key. TYPES: headerid TYPE odp_headerid, END OF tp_s_headerid
2	TP_S_ODP_HIER_ALL	Private	See coding			20130701	BEGIN OF tp_s_odp_hier_all, headerid TYPE odp_headerid, hienm TYPE rshienm, timestmp TYPE rstimestmp, nodeid TYPE odp_nodeid, parentid TYPE odp_parentid, childid TYPE odp_childid, nextid TYPE odp_nextid, tlevel TYPE rstlevel, intervl TYPE rsintervl, fieldname_asc TYPE fieldname, foldername TYPE odp_foldername, linkcount TYPE odp_linkcount, h_link TYPE rslink, END OF tp_s_odp_hier_all
3	TP_S_RSSH_ALL	Private	See coding			20130701	BEGIN OF tp_s_rssh_all, odp_headerid TYPE odp_headerid, h_hienm TYPE rshienm, h_timestmp TYPE rstimestmp, h_nodeid TYPE odp_nodeid, h_parentid TYPE odp_parentid, h_childid TYPE odp_childid, h_nextid TYPE odp_nextid, h_tlevel TYPE rstlevel, intervl TYPE rsintervl, h_iobjnm TYPE fieldname, h_hiernode TYPE odp_foldername, linkcount TYPE odp_linkcount, h_link TYPE rslink, END OF tp_s_rssh_all
4	TS_RECORDMODE	Protected	See coding			20130215	BEGIN OF ts_recordmode, recordmode TYPE rodmupdmod, odq_changemode TYPE odq_changemode, odq_entitycntr TYPE odq_entitycntr, END OF ts_recordmode
5	TS_SEGMENT	Private	See coding			20130701	BEGIN OF ts_segment, suffix TYPE if_rodps_odp=>t_suffix, fieldname TYPE fieldname, r_odp TYPE REF TO if_rodps_odp, r_data TYPE REF TO data, t_field TYPE if_rodps_odp_direct_access=>tt_field_aggregations, END OF ts_segment
6	TS_SEMANTIC_KEY	Private	See coding			20130701	BEGIN OF ts_semantic_key, fieldname_asc TYPE fieldname, r_data TYPE REF TO data, END OF ts_semantic_key
7	TT_SEGMENT	Private	See coding			20130701	tt_segment TYPE SORTED TABLE OF ts_segment WITH UNIQUE KEY suffix INITIAL SIZE 2
8	TT_SEMANTIC_KEY	Private	See coding			20130701	tt_semantic_key TYPE SORTED TABLE OF ts_semantic_key WITH UNIQUE KEY fieldname_asc INITIAL SIZE 1
9	T_FILL_ODQ_FIELDS	Protected	Type reference (TYPE)	I		20130215

Method Signatures

Method ADD_REQUID_TO_RANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_RID	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_RID			20130215
2	Importing	I_R_SELECTION_SET	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSMDS_SET		Multi-Dimensional Quantity	20130221
3	Importing	I_TSN_HIGH	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_TSN			20130215
4	Importing	I_TSN_LOW	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_TSN			20130215

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐		20130215
2	CX_ODQ_INPUT_INVALID	☐		20130215
3	CX_ODQ_NO_MORE_DATA	☐		20130215

Method CLOSE Signature

Method CLOSE on class CL_RSODP_BW_CURSOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐	Object does not exist	20130215

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXTRACTION_MODE	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_EXTRACTION_MODE			20130215
2	Importing	I_MAXIMUM_ROWS	Call by reference	☐	Type reference (TYPE)	I			20130215
3	Importing	I_RID	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_RID			20130215
4	Importing	I_R_LOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_ODQ_LOG			20130215
5	Importing	I_R_ODP	Call by reference	☐	Object reference (TYPE REF TO)	IF_RODPS_ODP		ODP metadata	20130221
6	Importing	I_R_SELECTION_SET	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSMDS_SET			20130215
7	Importing	I_SIMULATION	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_BOOLEAN			20130215
8	Importing	I_TSN_HIGH	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_TSN			20130215
9	Importing	I_TSN_LOW	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_TSN			20130215
10	Importing	I_T_PROJECTION	Call by reference	☐	Type reference (TYPE)	IF_RODPS_ODP=>TT_FIELD_PROJECTIONS			20130215

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐		20130215
2	CX_ODQ_INPUT_INVALID	☐		20130215
3	CX_ODQ_NOT_SUPPORTED	☐		20130215
4	CX_ODQ_NO_MORE_DATA	☐		20130215
5	CX_ODQ_OBJECT_NOT_FOUND	☐		20130215

Method CREATE_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ODP	Call by reference	☐	Object reference (TYPE REF TO)	IF_RODPS_ODP			20130701
2	Importing	IT_FIELD	Call by reference	☐	Type reference (TYPE)	IF_RODPS_ODP_DIRECT_ACCESS=>TT_FIELD_AGGREGATIONS			20130701
3	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20130701

#	Exception	Resumable	Description	Created on
1	CX_RODPS_INPUT_INVALID	☐		20130701

Method FETCH_NEXT_PACKAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_DATA	Call by reference	☑	Type reference (TYPE)	STANDARD TABLE			20130215
2	Importing	I_APPEND_ROWS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		General Flag	20130215
3	Importing	I_PACKAGE_SIZE	Call by reference	☑	Type reference (TYPE)	I		Benchmark for the Data Package in Number of Data Records	20130215
4	Importing	I_R_LOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ODQ_LOG		Log Handle for Operational Delta Queue	20130215

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐	Error while accessing data	20130215
2	CX_ODQ_INPUT_INVALID	☐	Invalid Parameter Value(s)	20130215
3	CX_ODQ_NO_MORE_DATA	☐	No more data records in the result set	20130215

Method GET_DATA_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_DTP_DATA	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSBK_DATA		Data Transfer Process: Data Package	20130215

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐	Error while accessing data	20130215

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXTRACTION_MODE	Call by reference	☑	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_EXTRACTION_MODE			20130215
2	Importing	I_MAXIMUM_ROWS	Call by reference	☑	Type reference (TYPE)	I			20130215
3	Importing	I_RID	Call by reference	☑	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_RID			20130215
4	Importing	I_R_LOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ODQ_LOG			20130215
5	Importing	I_R_ODP	Call by reference	☐	Object reference (TYPE REF TO)	IF_RODPS_ODP		ODP metadata	20130221
6	Importing	I_R_SELECTION_SET	Call by reference	☑	Object reference (TYPE REF TO)	CL_RSMDS_SET			20130215
7	Importing	I_SIMULATION	Call by reference	☑	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_BOOLEAN			20130215
8	Importing	I_TH_PROJECTIONS	Call by reference	☑	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>TTH_PROJECTIONS			20130215
9	Importing	I_TSN_HIGH	Call by reference	☑	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_TSN			20130215
10	Importing	I_TSN_LOW	Call by reference	☑	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_TSN			20130215
11	Importing	I_T_PROJECTION	Value transfer	☑	Type reference (TYPE)	IF_RODPS_ODP=>TT_FIELD_PROJECTIONS			20130215
12	Returning	R_R_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSODP_BW_CURSOR			20130215

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐		20130215
2	CX_ODQ_INPUT_INVALID	☐		20130215
3	CX_ODQ_NOT_SUPPORTED	☐		20130215
4	CX_ODQ_NO_MORE_DATA	☐		20130215
5	CX_ODQ_OBJECT_NOT_FOUND	☐		20130215

Method INIT_SEMANTIC_KEY Signature

Method INIT_SEMANTIC_KEY on class CL_RSODP_BW_CURSOR has no parameter.
Method INIT_SEMANTIC_KEY on class CL_RSODP_BW_CURSOR has no exception.

Method MOVE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20130701
2	Importing	IS_SEGMENT	Call by reference	☐	Type reference (TYPE)	TS_SEGMENT			20130701
3	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20130701

Method MOVE_DATA on class CL_RSODP_BW_CURSOR has no exception.

Method MOVE_RSSH_TO_ODP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_HEADERID	Call by reference	☐	Type reference (TYPE)	ODP_HEADERID		Hash ID for Hierarchy Header	20130701
2	Exporting	E_S_ODP	Call by reference	☐	Type reference (TYPE)	ANY			20130701
3	Importing	I_SEGID	Call by reference	☐	Type reference (TYPE)	RSBK_SEGID		Segment	20130701
4	Importing	I_S_RSSH	Call by reference	☐	Type reference (TYPE)	ANY			20130701

Method MOVE_RSSH_TO_ODP on class CL_RSODP_BW_CURSOR has no exception.

Method ON_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_EXCEPTION	Call by reference	☑	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20130215
2	Importing	I_R_LOG	Value transfer	☑	Object reference (TYPE REF TO)	IF_ODQ_LOG		Log Handle for Operational Delta Queue	20130215

Method ON_ERROR on class CL_RSODP_BW_CURSOR has no exception.

Method OPEN_DEFERRED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PACKAGE_SIZE	Call by reference	☑	Type reference (TYPE)	I			20130215
2	Importing	I_T_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20130215

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐	Error while accessing data	20130215
2	CX_ODQ_INPUT_INVALID	☐	Invalid Parameter Value(s)	20130215
3	CX_ODQ_NO_MORE_DATA	☐	No more data records in the result set	20130215

Method TSN_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TSN	Call by reference	☐	Type reference (TYPE)	IF_ODQ_QUEUE_MODEL=>T_TSN		TSN	20130215
2	Returning	R_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20130215

Method TSN_TO_STRING on class CL_RSODP_BW_CURSOR has no exception.

Method _FETCH_NEXT_PACKAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PACKAGE_SIZE	Call by reference	☑	Type reference (TYPE)	I		Benchmark for the Data Package in Number of Data Records	20130215
2	Returning	R_R_DATA	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSBK_DATA		Data Transfer Process: Data Package	20130701

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐	Error while accessing data	20130215
2	CX_ODQ_INPUT_INVALID	☐	Object does not exist	20130215
3	CX_ODQ_NO_MORE_DATA	☐	No more data records in the result set	20130215

Method _OPEN_DEFERRED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PACKAGE_SIZE	Call by reference	☑	Type reference (TYPE)	I			20130215

#	Exception	Resumable	Description	Created on
1	CX_ODQ_ACCESS_ERROR	☐	Error while accessing data	20130215
2	CX_ODQ_INPUT_INVALID	☐	Invalid Parameter Value(s)	20130215
3	CX_ODQ_NO_MORE_DATA	☐	No more data records in the result set	20130215

History

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