SAP ABAP Class CL_CNV_INDX_IO (Read/Write operations on INDX tables)

Hierarchy

☛ DMIS (Software Component) DMIS 2011_1
   ⤷ CA-GTF-BS (Application Component) Business Application Support
     ⤷ CNV_INDX (Package) Conversion of INDX-like cluster tables

Properties

Class	CL_CNV_INDX_IO
Short Description	Read/Write operations on INDX tables
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CNV_INDX	Conversion of INDX-like cluster tables
Created	20101210	SAP
Last change	20141030
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	RSDS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CNV_INDX_IO has no interface implemented.

Friends

Class CL_CNV_INDX_IO has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACTUAL_VARIANT	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_CNV_INDX_RELID_STR_VARIANT		Variant of the INDX structure	20101210
2	ACTUAL_VERSION	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_CNV_INDX_RELID_STR_VERSION		Externally defined version of the RELID structure	20101210
3	COMPONENTS	Instance attribute	Protected	☐	Type reference (TYPE)	TY_ST_COMP			20101210
4	CURRENT_CLIENT	Instance attribute	Public	☑	Type reference (TYPE)	MANDT		Read client	20101214
5	CURRENT_DATA	Instance attribute	Protected	☐	Type reference (TYPE)	XSTRING			20101210
6	HELPER	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_CNV_INDX_RULE_HELPER		Default INDX Rule helper	20101210
7	INDXID	Instance attribute	Public	☑	Type reference (TYPE)	CHAR255		INDX key	20101210
8	RELID	Instance attribute	Public	☑	Type reference (TYPE)	CNV_INDX_RELID		Description of the cluster in the cluster tables	20101210
9	RELIDREF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CNV_INDX_RELID		Representation of INDX RELID	20101210
10	ROWDATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA			20101213
11	ROWDATATAB	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA			20101214
12	TABLEREF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CNV_INDX_TABLE		INDX table representation	20101210
13	TABNAME	Instance attribute	Public	☑	Type reference (TYPE)	TABNAME		Table Name	20101210

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSIGN_REFERENCES	Instance method	Public	Method	Assigns references to components	20101213
2	BUILD_CLIENT_WHERE	Instance method	Protected	Method	Builds WHERE clause for client	20110624
3	BUILD_INDX_ID	Instance method	Public	Method	Builds INDX id from row	20101221
4	BUILD_INDX_ID_FROM_STRING	Instance method	Protected	Method	Builds INDX id from string	20110624
5	BUILD_RELID_WHERE	Instance method	Protected	Method	Builds WHERE clause for RELID	20110624
6	BUILD_WHERE	Instance method	Protected	Method	Builds WHERE clause	20110624
7	CLEAR_ROW	Instance method	Public	Method	Initializes the current row	20110823
8	CONSTRUCTOR	Instance method	Public	Constructor	Creates a read/write module for given RELID	20101210
9	CREATE_COMPONENT	Static method	Protected	Method	Creates a component variable dynamically	20101210
10	ESCAPE_WHERE_VALUE	Static method	Public	Method	Escapes a string to be written into database	20121017
11	EXPORT	Instance method	Public	Method	Emports INDX components to buffer	20101213
12	GET_COMPONENT	Instance method	Public	Method	Returns the component (and its reference) of the current row	20101214
13	GET_DIRECTORY	Instance method	Public	Method	Returns the directory for the current entry	20101210
14	GET_ROUTINE_NAME	Static method	Protected	Method	Returns the internal routine name	20101213
15	GET_ROWS	Instance method	Public	Method	Returns the database rows for the current key	20101221
16	GET_VERSION_FOR_KEY	Instance method	Public	Method	Returns the version of the entry for a given key	20110624
17	IMPORT	Instance method	Public	Method	Actually imports INDX components from buffer	20101213
18	IMPORT_SINGLE	Instance method	Public	Method	Imports a single component	20110721
19	NEW_ENTRY	Instance method	Public	Method	Initializes a new entry	20101222
20	READ	Instance method	Public	Method	Reads an entry from INDX table	20101210
21	SET_COMPONENT	Instance method	Public	Method	Assigns the value of the given component	20101214
22	SET_ROWS	Instance method	Public	Method	Assigns the database rows for the current key	20101221
23	WRITE	Instance method	Public	Method	Writes current row (to the given client)	20101214

Events

Class CL_CNV_INDX_IO has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_COMP	Protected	See coding			20101210
2	TY_ST_COMP	Protected	See coding			20101210

Method Signatures

Method ASSIGN_REFERENCES Signature

Method ASSIGN_REFERENCES on class CL_CNV_INDX_IO has no parameter.
Method ASSIGN_REFERENCES on class CL_CNV_INDX_IO has no exception.

Method BUILD_CLIENT_WHERE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	SYMANDT	SY-MANDT	R/3 System, client number from logon	20110624
2	Changing	WHERE	Call by reference	☐	Type reference (TYPE)	RSDS_WHERE_TAB			20110624

Method BUILD_CLIENT_WHERE on class CL_CNV_INDX_IO has no exception.

Method BUILD_INDX_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ROW	Call by reference	☐	Type reference (TYPE)	ANY			20101221
2	Changing	WHERE	Call by reference	☑	Type reference (TYPE)	RSDS_WHERE_TAB			20101221

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_ASSIGN_ERROR	☐	Component type not found in DDIC	20101221

Method BUILD_INDX_ID_FROM_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEYSTRING	Call by reference	☐	Type reference (TYPE)	C			20110624
2	Changing	WHERE	Call by reference	☐	Type reference (TYPE)	RSDS_WHERE_TAB			20110624

Method BUILD_INDX_ID_FROM_STRING on class CL_CNV_INDX_IO has no exception.

Method BUILD_RELID_WHERE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	WHERE	Call by reference	☐	Type reference (TYPE)	RSDS_WHERE_TAB			20110624

Method BUILD_RELID_WHERE on class CL_CNV_INDX_IO has no exception.

Method BUILD_WHERE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	SYMANDT	SY-MANDT	R/3 System, client number from logon	20110624
2	Importing	ROW	Call by reference	☐	Type reference (TYPE)	ANY			20110624
3	Exporting	WHERE	Call by reference	☐	Type reference (TYPE)	RSDS_WHERE_TAB			20110624

Method BUILD_WHERE on class CL_CNV_INDX_IO has no exception.

Method CLEAR_ROW Signature

Method CLEAR_ROW on class CL_CNV_INDX_IO has no parameter.
Method CLEAR_ROW on class CL_CNV_INDX_IO has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RELID	Call by reference	☐	Object reference (TYPE REF TO)	CL_CNV_INDX_RELID		Description of the cluster in the cluster tables	20101210

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_RELID_UNKNOWN	☐	Unknown RELID exception	20101210
2	CX_CNV_INDX_TABLE_UNKNOWN	☐	Unknown INDX table exception	20101210

Method CREATE_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPONENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_CNV_INDX_COMPONENT		INDX RELID component	20101210
2	Returning	REF	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20101210

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_COMP_TYPE_UNKNOWN	☐	Component type unknown	20101210
2	CX_SY_CREATE_DATA_ERROR	☐	System-Exception Creating Data	20101210

Method ESCAPE_WHERE_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ESCAPED_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20121017
2	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	CLIKE			20121017

Method ESCAPE_WHERE_VALUE on class CL_CNV_INDX_IO has no exception.

Method EXPORT Signature

Method EXPORT on class CL_CNV_INDX_IO has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_DATA_WRITE_FAILED	☐	Error writing INDX data	20101213
2	CX_CNV_INDX_READ_NOT_READY	☐	Necessary data has not been loaded yet	20101214

Method GET_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPNAME	Call by reference	☐	Type reference (TYPE)	CNV_INDX_TABNAME		Name of structure/table in cluster	20101214
2	Exporting	DATA	Call by reference	☐	Type reference (TYPE)	ANY		Component value	20101214
3	Exporting	DATAREF	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Reference to component value	20101214

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_COMP_UNKNOWN	☐	Unknown component exception	20101214
2	CX_CNV_INDX_READ_NOT_READY	☐	Necessary data has not been loaded yet	20101214

Method GET_DIRECTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☑	Type reference (TYPE)	MANDT		Client	20101215
2	Returning	DIRECTORY	Value transfer	☐	Type reference (TYPE)	TAB_CDIR		Table of CDIRs	20101210
3	Importing	KEY	Call by reference	☑	Type reference (TYPE)	ANY		INDX id	20101215

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_DATA_RETR_FAILED	☐	Error retrieving INDX data	20101210

Method GET_ROUTINE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BASE_NAME	Call by reference	☐	Type reference (TYPE)	C			20101213
2	Returning	NAME	Value transfer	☐	Type reference (TYPE)	STRING			20101213
3	Importing	VARIANT	Call by reference	☐	Type reference (TYPE)	CNV_INDX_STRUCT_VARIANT		Variant of the INDX structure	20101213
4	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	CNV_INDX_VERSION		Externally defined version of the RELID structure	20101213

Method GET_ROUTINE_NAME on class CL_CNV_INDX_IO has no exception.

Method GET_ROWS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20101221
2	Exporting	ROWS	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20101221
3	Exporting	ROWSREF	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20101221
4	Importing	WRITE_DB	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	Whether to write data to DB	20101221

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_ASSIGN_ERROR	☐	Component type not found in DDIC	20101221
2	CX_CNV_INDX_DATA_WRITE_FAILED	☐	Error writing INDX data	20101221

Method GET_VERSION_FOR_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client	20110624
2	Importing	KEY	Call by reference	☐	Type reference (TYPE)	C			20110624
3	Exporting	VERSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_CNV_INDX_RELID_STR_VERSION		Externally defined version of the RELID structure	20110624
4	Exporting	VERSN	Call by reference	☐	Type reference (TYPE)	CNV_INDX_VERSION		Externally defined version of the RELID structure	20110624

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_DATA_RETR_FAILED	☐	Error retrieving INDX data	20110624

Method IMPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IGNORE_STRUCTURE_BOUNDARIES	Call by reference	☑	Type reference (TYPE)	CNV_INDX_IGNORE_BOUNDARIES		Ignore structure boundries	20110616

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_DATA_RETR_FAILED	☐	Error retrieving INDX data	20101213
2	CX_CNV_INDX_READ_NOT_READY	☐	Necessary data has not been loaded yet	20101214

Method IMPORT_SINGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DATA	Call by reference	☐	Type reference (TYPE)	ANY			20110721
2	Importing	IGNORE_STRUCTURE_BOUNDARIES	Call by reference	☑	Type reference (TYPE)	CNV_INDX_IGNORE_BOUNDARIES		Ignore structure boundries	20110826
3	Importing	NAME	Call by reference	☐	Type reference (TYPE)	C			20110721

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_DATA_RETR_FAILED	☐	Error retrieving INDX data	20110721
2	CX_CNV_INDX_READ_NOT_READY	☐	Necessary data has not been loaded yet	20110721

Method NEW_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client	20101222
2	Importing	KEY_STRUCT	Call by reference	☐	Type reference (TYPE)	ANY			20101222
3	Importing	VARIANT	Call by reference	☑	Type reference (TYPE)	CNV_INDX_STRUCT_VARIANT		Variant of the INDX structure	20101222
4	Importing	VERSION	Call by reference	☑	Type reference (TYPE)	CNV_INDX_VERSION		Externally defined version of the RELID structure	20101222

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_ASSIGN_ERROR	☐	Component type not found in DDIC	20101222
2	CX_CNV_INDX_VARIANT_UNKNOWN	☐	Unknown RELID structure variant exception	20101222
3	CX_CNV_INDX_VERSION_UNKNOWN	☐	Unknown version exception	20101222

Method READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client	20101210
2	Importing	ROW	Call by reference	☑	Type reference (TYPE)	ANY			20101210

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_ASSIGN_ERROR	☐	Component type not found in DDIC	20101221
2	CX_CNV_INDX_DATA_RETR_FAILED	☐	Error retrieving INDX data	20101210
3	CX_CNV_INDX_VARIANT_UNKNOWN	☐	Unknown RELID structure variant exception	20101210
4	CX_CNV_INDX_VERSION_UNKNOWN	☐	Unknown version exception	20101210
5	CX_CNV_MBT_AUTHORITY	☐	Issues related to Authority/Registration	20140320

Method SET_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPNAME	Call by reference	☐	Type reference (TYPE)	CNV_INDX_TABNAME		Name of structure/table in cluster	20101214
2	Importing	DATA	Call by reference	☐	Type reference (TYPE)	ANY		Component value	20101214

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_COMP_UNKNOWN	☐	Unknown component exception	20101214
2	CX_CNV_INDX_READ_NOT_READY	☐	Necessary data has not been loaded yet	20101214

Method SET_ROWS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client	20101221
2	Importing	ROWS	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20101221

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_ASSIGN_ERROR	☐	System Exception Using ASSIGN	20101221
2	CX_CNV_INDX_DATA_RETR_FAILED	☐	Error retrieving INDX data	20101221
3	CX_CNV_INDX_VARIANT_UNKNOWN	☐	Unknown RELID structure variant exception	20101221
4	CX_CNV_INDX_VERSION_UNKNOWN	☐	Unknown version exception	20101221
5	CX_CNV_MBT_AUTHORITY	☐	Issues related to Authority/Registration	20140320

Method WRITE Signature

Method WRITE on class CL_CNV_INDX_IO has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CNV_INDX_ASSIGN_ERROR	☐	Component type not found in DDIC	20101221
2	CX_CNV_INDX_DATA_WRITE_FAILED	☐	Error writing INDX data	20101214

History

Last changed by/on	SAP	20141030
SAP Release Created in	2010_1_620