SAP ABAP Class CL_CNV_INDX_RELID (Representation of INDX RELID)
Hierarchy
☛ DMIS (Software Component) DMIS 2011_1
   ⤷ CA-GTF-BS (Application Component) Business Application Support
     ⤷ CNV_INDX (Package) Conversion of INDX-like cluster tables
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_CNV_INDX_CONF_OBJECT Configuration object 20101011
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_CNV_MBT_UNITTEST Unit testing @ SLO 20120927
Properties
Class CL_CNV_INDX_RELID  
Short Description Representation of INDX RELID    
Super Class CL_CNV_INDX_CONF_OBJECT Configuration object 
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 20101011   SAP 
Last change 20141030    
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 RSDS Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_CNV_MBT_UNITTEST Unit testing @ SLO 20120927
Friends
# Friend Modeled only Created on Description
1 CL_CNV_INDX 20101025 INDX helper class
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GEN_DATE Instance attribute Public Type reference (TYPE) SYDATUM Date of program generation 20101011
2 GEN_HASH Instance attribute Public Type reference (TYPE) CHAR32 Data hash for generation 20110615
3 GEN_PROGNAME Instance attribute Public Type reference (TYPE) SYREPID Name of the generated program 20101011
4 GEN_TIME Instance attribute Public Type reference (TYPE) SYUZEIT Time of program generation 20101011
5 GET_DATA_ROUTINENAME Instance attribute Protected Type reference (TYPE) FUNCNAME Function name 20101011
6 IE_METHOD_VARIANTS Instance attribute Protected Type reference (TYPE) TY_HT_IE_RETR_VARIANT 20101011
7 IE_METHOD_VARLIST Instance attribute Protected Type reference (TYPE) CNV_INDX_T_CL_IE_METH_VARIANT List of import / export method variants 20101011
8 IO Instance attribute Protected Object reference (TYPE REF TO) CL_CNV_INDX_IO INDX input/output operations proxy 20101214
9 MISSING_DDIC_REFS Instance attribute Public Type reference (TYPE) FLAG Whether missing DDIC references exist 20101011
10 NAME Instance attribute Public Type reference (TYPE) CNV_INDX_RELID Description of the cluster in the cluster tables 20101011
11 NEEDS_GENERATION Instance attribute Public Type reference (TYPE) FLAG 'X' Whether the program needs to be generated 20101011
12 RULE_INCLUDES Instance attribute Public Type reference (TYPE) SCR_PROGRAMS Includes for rules 20101011
13 STRUCT_RETR_VARIANTS Instance attribute Protected Type reference (TYPE) TY_HT_STR_RETR_VARIANT 20101011
14 STRUCT_RETR_VARLIST Instance attribute Protected Type reference (TYPE) CNV_INDX_T_CL_STR_RETR_VARI List of structure retrieval variants 20101011
15 TABLEREF Instance attribute Public Object reference (TYPE REF TO) CL_CNV_INDX_TABLE INDX table representation 20101011
16 VERSIONLIST Instance attribute Protected Type reference (TYPE) CNV_INDX_T_CL_RELID_STR_VERS List of RELID versions 20101011
17 VERSIONS Instance attribute Protected Type reference (TYPE) TY_HT_VERSION 20101011
18 VERSION_CONFIGS Instance attribute Protected Type reference (TYPE) CNV_INDX_T_CL_CONFIG List of config entries 20101011
Methods
# Method Level Visibility Method type Description Created on
1 ADD_IE_METHOD_VARIANT Instance method Public Method Adds an import / export method variant 20101011
2 ADD_STRUCT_RETR_VARIANT Instance method Public Method Adds a structure retrieval variant 20101011
3 ADD_VERSION Instance method Public Method Adds a version 20101011
4 BUILD_KEY_WHERE Instance method Protected Method Builds WHERE cluase for INDX table key 20101011
5 CHECK_DATA_EXISTS Instance method Public Method Checks if there is at least on entry with this RELID 20101025
6 CLEAR_GENERATION_DATA Instance method Public Method Clears the generation data 20101027
7 CONSTRUCTOR Instance method Public Constructor Creates a INDX RELID representation 20101011
8 GENERATE_PROGRAMS Instance method Public Method Triggers generation of the corresponding retrieval programs 20101026
9 GET_COMPONENT Instance method Public Method Searches all versions and variants for a given component 20110114
10 GET_DATA Instance method Public Method Gets the actual data from the RELID 20101011
11 GET_DIRECTORY Instance method Public Method Returns the directory of the given row 20101215
12 GET_HASH_FOR_GENERATION Instance method Public Method Returns the hash for generation 20110615
13 GET_IE_METHOD_VARIANT Instance method Public Method Returns import / export method variant with the given name 20101011
14 GET_IE_METHOD_VARIANTS Instance method Public Method Returns all or selected import / export method variants 20101011
15 GET_IO Instance method Public Method Returns the RELIDs I/O proxy 20101221
16 GET_STATE_NAME Instance method Public Method Returns the name to be used in state management 20110112
17 GET_STRUCT_RETR_VARIANT Instance method Public Method Returns the strucure retrieval variant with given name 20101011
18 GET_STRUCT_RETR_VARIANTS Instance method Public Method Returns all or selected structure retrieval variants 20101011
19 GET_VERSION Instance method Public Method Returns the version with the given name 20101011
20 GET_VERSIONS Instance method Public Method Returns all versions 20101011
21 INIT_IO Instance method Public Method Initializes I/O proxy 20101214
22 NEEDS_REGENERATION Instance method Public Method Whether program need to be regenerated 20101011
23 REGISTER_RULE_INCLUDE Instance method Public Method Registers an include for a variant rule 20101011
24 REPORT_MISSING_DDIC_REFS Instance method Public Method Reports missing DDIC references 20101011
25 SELECT_DATA Instance method Protected Method Retrieves the data into result set 20101011
26 SELECT_KEYS Instance method Protected Method Selects requested keys 20101011
27 SET_GENERATION_DATA Instance method Public Method Sets the name, date and time of the generated program 20101011
28 STATIC_CHECK_DATA_EXISTS Static method Public Method Checks if there is at least on entry with given RELID 20101025
29 STATIC_GET_LOG_LONG_NAME Static method Public Method Returns the long name of the given RELID 20101206
Events
Class CL_CNV_INDX_RELID has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_HT_IE_RETR_VARIANT Protected See coding 20101011
2 TY_HT_STR_RETR_VARIANT Protected See coding 20101011
3 TY_HT_VERSION Protected See coding 20101011
4 TY_IE_RETR_VARIANT Protected See coding 20101011
5 TY_STR_RETR_VARIANT Protected See coding 20101011
6 TY_VERSION Protected See coding 20101011
Method Signatures

Method ADD_IE_METHOD_VARIANT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing VARIANT Call by reference Object reference (TYPE REF TO) CL_CNV_INDX_IE_METH_VARIANT Import / export method variant 20101011

Method ADD_IE_METHOD_VARIANT on class CL_CNV_INDX_RELID has no exception.

Method ADD_STRUCT_RETR_VARIANT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing VARIANT Call by reference Object reference (TYPE REF TO) CL_CNV_INDX_STR_RETR_VARIANT INDX RELID structure retriever variant 20101011

Method ADD_STRUCT_RETR_VARIANT on class CL_CNV_INDX_RELID has no exception.

Method ADD_VERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing VERSION Call by reference Object reference (TYPE REF TO) CL_CNV_INDX_RELID_STR_VERSION Representation of RELID version 20101011

Method ADD_VERSION on class CL_CNV_INDX_RELID has no exception.

Method BUILD_KEY_WHERE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ALL_VERSIONS Call by reference Type reference (TYPE) FLAG SPACE Ignore version in WHERE clause 20101025
2 Importing CLIENT Call by reference Type reference (TYPE) MANDT Client 20101011
3 Importing KEY_RANGE Call by reference Type reference (TYPE) RSDS_FRANGE_T Key range 20101011
4 Exporting WHERE Call by reference Type reference (TYPE) RSDS_WHERE_TAB WHERE tab 20101011

Method BUILD_KEY_WHERE on class CL_CNV_INDX_RELID has no exception.

Method CHECK_DATA_EXISTS 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 20101025
2 Returning RES Value transfer Type reference (TYPE) FLAG General Flag 20101025
# Exception Resumable Description Created on
1 CX_CNV_MBT_AUTHORITY Issues related to Authority/Registration 20140206

Method CLEAR_GENERATION_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PERSIST Call by reference Type reference (TYPE) FLAG Whether to persist data in DB 20101027

Method CLEAR_GENERATION_DATA on class CL_CNV_INDX_RELID 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 Type reference (TYPE) CNV_INDX_RELID Description of the cluster in the cluster tables 20101011
2 Importing TABLEREF Call by reference Object reference (TYPE REF TO) CL_CNV_INDX_TABLE Reference to the table to which this RELID belong 20101011

Method CONSTRUCTOR on class CL_CNV_INDX_RELID has no exception.

Method GENERATE_PROGRAMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting REALLY_GENERATED Value transfer Type reference (TYPE) FLAG General Flag 20101027
2 Exporting REPORT_NAME Call by reference Type reference (TYPE) PROGNAME Report name 20101027
# Exception Resumable Description Created on
1 CX_CNV_INDX_GENERATION_ERROR Error generating INDX code 20101026

Method GET_COMPONENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning COMPONENT Value transfer Object reference (TYPE REF TO) CL_CNV_INDX_COMPONENT INDX RELID component 20110114
2 Importing NAME Call by reference Type reference (TYPE) CNV_INDX_TABNAME Name of structure/table in cluster 20110114
# Exception Resumable Description Created on
1 CX_CNV_INDX_COMP_UNKNOWN Unknown component exception 20110114

Method GET_DATA 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 20101011
2 Importing IGNORE_STRUCTURE_BOUNDARIES Call by reference Type reference (TYPE) CNV_INDX_IGNORE_BOUNDARIES Ignore structure boundries 20110616
3 Importing KEY_RANGE Call by reference Type reference (TYPE) RSDS_FRANGE_T Key field ranges 20101011
4 Importing MAX_ROWS Call by reference Type reference (TYPE) INT4 200 Maximum number of rows to select 20101011
5 Returning RESULTSET Value transfer Object reference (TYPE REF TO) CL_CNV_INDX_RESULTSET Result of INDX selection 20101011
# Exception Resumable Description Created on
1 CX_CNV_INDX_COMP_UNKNOWN Unknown component exception 20101012
2 CX_CNV_INDX_DATA_RETR_FAILED Error retrieving INDX data 20101012
3 CX_CNV_INDX_GENERATION_ERROR Error generating INDX code 20101012
4 CX_CNV_INDX_STRUCT_RETR_FAILED Error retrieving RELID structure 20101012

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 SY-MANDT Client 20101215
2 Returning DIRECTORY Value transfer Type reference (TYPE) TAB_CDIR Table of CDIRs 20101215
3 Importing KEY Call by reference Type reference (TYPE) ANY 20101215
# Exception Resumable Description Created on
1 CX_CNV_INDX_DATA_RETR_FAILED Error retrieving INDX data 20101215

Method GET_HASH_FOR_GENERATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning HASH Value transfer Type reference (TYPE) CHAR32 Character field, length 32 20110615

Method GET_HASH_FOR_GENERATION on class CL_CNV_INDX_RELID has no exception.

Method GET_IE_METHOD_VARIANT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) CNV_INDX_IMPEX_VARIANT Alternative RELID import / export routine variant 20101011
2 Returning VARIANT Value transfer Object reference (TYPE REF TO) CL_CNV_INDX_IE_METH_VARIANT Import / export method variant 20101011
# Exception Resumable Description Created on
1 CX_CNV_INDX_VARIANT_UNKNOWN Unknown RELID structure variant exception 20101012

Method GET_IE_METHOD_VARIANTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME_PATTERN Call by reference Type reference (TYPE) CNV_INDX_IMPEX_VARIANT Alternative RELID import / export routine variant 20101011
2 Returning VARIANTS Value transfer Type reference (TYPE) CNV_INDX_T_CL_IE_METH_VARIANT List of import / export method variants 20101011

Method GET_IE_METHOD_VARIANTS on class CL_CNV_INDX_RELID has no exception.

Method GET_IO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning IO Value transfer Object reference (TYPE REF TO) CL_CNV_INDX_IO Read/Write operations on INDX tables 20101221

Method GET_IO on class CL_CNV_INDX_RELID has no exception.

Method GET_STATE_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NAME Value transfer Type reference (TYPE) TABNAME Name to be used as table name in state management 20110112

Method GET_STATE_NAME on class CL_CNV_INDX_RELID has no exception.

Method GET_STRUCT_RETR_VARIANT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) CNV_INDX_STRUCT_RETR_VARIANT Alternative variant of RELID structure retrieval method 20101011
2 Returning VARIANT Value transfer Object reference (TYPE REF TO) CL_CNV_INDX_STR_RETR_VARIANT INDX RELID structure retriever variant 20101011
# Exception Resumable Description Created on
1 CX_CNV_INDX_VARIANT_UNKNOWN Unknown RELID structure retrieval variant exception 20101012

Method GET_STRUCT_RETR_VARIANTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME_PATTERN Call by reference Type reference (TYPE) CNV_INDX_STRUCT_RETR_VARIANT Alternative variant of RELID structure retrieval method 20101011
2 Returning VARIANTS Value transfer Type reference (TYPE) CNV_INDX_T_CL_STR_RETR_VARI List of structure retrieval variants 20101011

Method GET_STRUCT_RETR_VARIANTS on class CL_CNV_INDX_RELID has no exception.

Method GET_VERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) CNV_INDX_VERSION Externally defined version of the RELID structure 20101011
2 Returning VERSION Value transfer Object reference (TYPE REF TO) CL_CNV_INDX_RELID_STR_VERSION Representation of RELID version 20101011
# Exception Resumable Description Created on
1 CX_CNV_INDX_VERSION_UNKNOWN Unknown version exception 20101012

Method GET_VERSIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME_PATTERN Call by reference Type reference (TYPE) CNV_INDX_VERSION Externally defined version of the RELID structure 20101011
2 Returning VERSIONS Value transfer Type reference (TYPE) CNV_INDX_T_CL_RELID_STR_VERS List of RELID versions 20101011

Method GET_VERSIONS on class CL_CNV_INDX_RELID has no exception.

Method INIT_IO Signature

Method INIT_IO on class CL_CNV_INDX_RELID has no parameter.
Method INIT_IO on class CL_CNV_INDX_RELID has no exception.

Method NEEDS_REGENERATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RES Value transfer Type reference (TYPE) FLAG General Flag 20101011

Method NEEDS_REGENERATION on class CL_CNV_INDX_RELID has no exception.

Method REGISTER_RULE_INCLUDE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INCL Call by reference Type reference (TYPE) PROGRAM Include name 20101011

Method REGISTER_RULE_INCLUDE on class CL_CNV_INDX_RELID has no exception.

Method REPORT_MISSING_DDIC_REFS Signature

Method REPORT_MISSING_DDIC_REFS on class CL_CNV_INDX_RELID has no parameter.
Method REPORT_MISSING_DDIC_REFS on class CL_CNV_INDX_RELID has no exception.

Method SELECT_DATA 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 20101011
2 Importing IGNORE_STRUCTURE_BOUNDARIES Call by reference Type reference (TYPE) CNV_INDX_IGNORE_BOUNDARIES Ignore structure boundries 20110616
3 Importing KEY_RANGE Call by reference Type reference (TYPE) RSDS_FRANGE_T Key range 20101011
4 Importing MAX_ROWS Call by reference Type reference (TYPE) I 200 20101011
5 Returning RESULTSET Value transfer Object reference (TYPE REF TO) CL_CNV_INDX_RESULTSET Result of INDX selection 20101011
# Exception Resumable Description Created on
1 CX_CNV_INDX_DATA_RETR_FAILED Error retrieving INDX data 20101012
2 CX_SY_CREATE_DATA_ERROR System-Exception Creating Data 20101011

Method SELECT_KEYS 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 20101011
2 Importing MAX_ROWS Call by reference Type reference (TYPE) I 200 Maximal number of rows to select 20101011
3 Returning RESULTSET Value transfer Object reference (TYPE REF TO) CL_CNV_INDX_RESULTSET Result of INDX selection 20101011
4 Importing WHERE Call by reference Type reference (TYPE) RSDS_WHERE_TAB 20101011
# Exception Resumable Description Created on
1 CX_SY_CREATE_DATA_ERROR System-Exception Creating Data 20101011

Method SET_GENERATION_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing GEN_DATE Call by reference Type reference (TYPE) SYDATUM Date and Time, Current (Application Server) Date 20101011
2 Importing GEN_HASH Call by reference Type reference (TYPE) CHAR32 Hash of data 20110615
3 Importing GEN_PROGNAME Call by reference Type reference (TYPE) PROGNAME ABAP program name 20101011
4 Importing GEN_TIME Call by reference Type reference (TYPE) SYUZEIT Date and Time, Current Application Server Time 20101011
5 Importing PERSIST Call by reference Type reference (TYPE) FLAG Whether to persist data in DB 20101011

Method SET_GENERATION_DATA on class CL_CNV_INDX_RELID has no exception.

Method STATIC_CHECK_DATA_EXISTS 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 20101025
2 Importing CLIENT_FNAME Call by reference Type reference (TYPE) FIELDNAME Field Name 20101025
3 Importing RELID Call by reference Type reference (TYPE) CNV_INDX_RELID Description of the cluster in the cluster tables 20101025
4 Importing RELID_FNAME Call by reference Type reference (TYPE) FIELDNAME Field Name 20101025
5 Returning RES Value transfer Type reference (TYPE) FLAG General Flag 20101025
6 Importing TABNAME Call by reference Type reference (TYPE) TABNAME Table Name 20101025
# Exception Resumable Description Created on
1 CX_CNV_MBT_AUTHORITY Issues related to Authority/Registration 20140206

Method STATIC_GET_LOG_LONG_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NAME Value transfer Type reference (TYPE) STRING 20101206
2 Importing RELID Call by reference Type reference (TYPE) CNV_INDX_RELID Description of the cluster in the cluster tables 20101206
3 Importing TABNAME Call by reference Type reference (TYPE) TABNAME Table Name 20101206

Method STATIC_GET_LOG_LONG_NAME on class CL_CNV_INDX_RELID has no exception.
History
Last changed by/on SAP  20141030 
SAP Release Created in 2010_1_620