SAP ABAP Interface IF_RSB_READ_API (Interface for Read API)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-WHM-DBA (Application Component) Data Basis
     ⤷ RSB (Package) Business Information Warehouse: Data Marts

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_RSB_DBTAB_3RD	Open Hub Destination: DB Table	20090202

Properties

Interface	IF_RSB_READ_API
Short Description	Interface for Read API

General Data

Package	RSB	Business Information Warehouse: Data Marts
Created	20090202	SAP
Last changed	20130531	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_RSB_READ_API has no interface.

Friends

Interface IF_RSB_READ_API has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_DTP_REQUEST	Instance attribute	Public	☐	Type reference (TYPE)	RS_BOOL		Boolean	20090216
2	N_DUMMY_MSG	Instance attribute	Public	☐	Type reference (TYPE)	C			20090202
3	N_LOCK	Instance attribute	Public	☐	Type reference (TYPE)	RS_BOOL		Boolean	20090216
4	N_MAX_LENGTH	Instance attribute	Public	☐	Type reference (TYPE)	I			20090202
5	N_NO_TECKEY	Instance attribute	Public	☐	Type reference (TYPE)	RS_BOOL		Boolean	20090202
6	N_R_LOG	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_RSB_LOG		Open Hub: Log for Request	20090216
7	N_TABNAME	Instance attribute	Public	☐	Type reference (TYPE)	RSBTABNAME		Database Table	20090202
8	N_T_DATALAYOUT	Instance attribute	Public	☐	Type reference (TYPE)	TY_T_DATALAYOUT			20090202
9	N_T_STRUCTURE	Instance attribute	Public	☐	Type reference (TYPE)	TY_T_STRUCTURE		Metadata Repository: Table with Transform. Struct. Fields	20090202

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_REQUEST_VALID	Instance method	Public	Method	Checks Whether Request is Valid	20090216
2	CREATE_LAYOUT	Instance method	Public	Method	Creates Layout	20090202
3	DEQUEUE	Instance method	Public	Method	Unlock	20090202
4	ENQUEUE	Instance method	Public	Method	Locks	20090202
5	GET_DATA	Instance method	Public	Method	Reads Data from Table (Including Conversion)	20090202
6	GET_DATA_RAW	Instance method	Public	Method	Reads Data from Table (Including Conversion)	20100317
7	GET_STATUS	Instance method	Public	Method	Returns Status of Destination	20090202
8	GET_TABLE	Instance method	Public	Method	Returns Table	20090202
9	GET_TABLE_FIELD	Instance method	Public	Method	Returns Table Fields	20090202

Events

Interface IF_RSB_READ_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_DATALAYOUT	Public	Type reference (TYPE)	BAPI6118DALO		20090202
2	TY_S_STRUCTURE	Public	Type reference (TYPE)	BAPI6100FL		20090202
3	TY_T_DATALAYOUT	Public	See coding			20090202	ty_t_datalayout TYPE TABLE OF ty_s_datalayout
4	TY_T_STRUCTURE	Public	See coding			20090202	ty_t_structure TYPE TABLE OF ty_s_structure WITH NON-UNIQUE KEY fieldnm

Method Signatures

Method CHECK_REQUEST_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REQUESTID	Call by reference	☐	Type reference (TYPE)	RSBREQUIDOUT		Request im Zielobjekt einer InfoSpoke	20090216
2	Returning	R_VALID	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20090216

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20090216

Method CREATE_LAYOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_DATALAYOUT	Call by reference	☐	Type reference (TYPE)	TY_T_DATALAYOUT			20090202

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20090216

Method DEQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PACKETID	Call by reference	☑	Type reference (TYPE)	I			20090216
2	Importing	I_REQUESTID	Call by reference	☐	Type reference (TYPE)	RSBREQUIDOUT		Request im Zielobjekt einer InfoSpoke	20090202
3	Importing	I_WITH_END_MSG	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110311

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20090216

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ENQUEUE_LOOP_COUNT	Call by reference	☐	Type reference (TYPE)	I			20090216
2	Importing	I_PACKETID	Call by reference	☑	Type reference (TYPE)	I		Nur fürs Logging	20090216
3	Importing	I_REQUESTID	Call by reference	☐	Type reference (TYPE)	RSBREQUIDOUT		Request im Zielobjekt einer InfoSpoke	20090202
4	Importing	I_WITH_START_MSG	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110311

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20090216

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LINES	Call by reference	☐	Type reference (TYPE)	I			20090202
2	Exporting	E_LINES_PER_RECORD	Call by reference	☐	Type reference (TYPE)	I			20090202
3	Exporting	E_NUMB_OF_PACKETS	Call by reference	☐	Type reference (TYPE)	I			20090202
4	Exporting	E_T_DATA	Call by reference	☐	Type reference (TYPE)	BAPI6116TDA		Tabellendaten - Datensatz mit Fortsetzungske	20090202
5	Importing	I_LINE_LENGTH	Call by reference	☐	Type reference (TYPE)	I	250		20090202
6	Importing	I_NO_TECKEY	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Boolean	20090202
7	Importing	I_PACKETID	Call by reference	☑	Type reference (TYPE)	I			20090202
8	Importing	I_REQUESTID	Call by reference	☐	Type reference (TYPE)	RSBREQUIDOUT		Request im Zielobjekt einer InfoSpoke	20090202

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20090216

Method GET_DATA_RAW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LINES	Call by reference	☐	Type reference (TYPE)	I			20100317
2	Exporting	E_LINES_PER_RECORD	Call by reference	☐	Type reference (TYPE)	I			20100317
3	Exporting	E_NUMB_OF_PACKETS	Call by reference	☐	Type reference (TYPE)	I			20100317
4	Exporting	E_T_DATA_RAW	Call by reference	☐	Type reference (TYPE)	RSB_T_DATARAW			20100317
5	Importing	I_ENCODING	Call by reference	☐	Type reference (TYPE)	ABAP_ENCOD	'UTF-8'	Bezeichner für das Zeichenformat (UTF-8, UCS-2, ...)	20100317
6	Importing	I_LINE_LENGTH	Call by reference	☐	Type reference (TYPE)	I	250		20100317
7	Importing	I_NO_TECKEY	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Boolean	20100317
8	Importing	I_PACKETID	Call by reference	☑	Type reference (TYPE)	I			20100317
9	Importing	I_REQUESTID	Call by reference	☐	Type reference (TYPE)	RSBREQUIDOUT		Request im Zielobjekt einer InfoSpoke	20100317

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20100317

Method GET_STATUS Signature

Method GET_STATUS on Interface IF_RSB_READ_API has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20090216

Method GET_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TABNAME	Call by reference	☐	Type reference (TYPE)	RSBTABNAME		Datenbank Tabelle	20090202

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20090216

Method GET_TABLE_FIELD Signature

Method GET_TABLE_FIELD on Interface IF_RSB_READ_API has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_RSB_GUI_ERROR_WITH_MESSAGE	☐	Ausnahme mit Meldung	20090216

History

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