SAP ABAP Class CL_CNV_00001_API_ROUTINE (Routine representation)
Hierarchy
☛
DMIS (Software Component) DMIS 2011_1
⤷
CA-GTF-BS (Application Component) Business Application Support
⤷
CNV_BASIS (Package) Conversion: Basis functions
DMIS (Software Component) DMIS 2011_1⤷
CA-GTF-BS (Application Component) Business Application Support⤷
CNV_BASIS (Package) Conversion: Basis functionsMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_CNV_00001_MODIFIABLE | Abstrct modifiable cust. object | 20110321 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_CNV_00001_API_CUST_OBJECT | Abstract customizing object availabel in CWB API | 20110207 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_CNV_MBT_UNITTEST | Unit testing @ SLO | 20120911 |
Properties
| Class | CL_CNV_00001_API_ROUTINE | |
| Short Description | Routine representation | |
| Super Class | CL_CNV_00001_MODIFIABLE | Abstrct modifiable cust. object |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CNV_BASIS | Conversion: Basis functions |
| Created | 20110207 | SAP |
| Last change | 20141030 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  CNV |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_CNV_00001_API_CUST_OBJECT | Abstract customizing object availabel in CWB API | 20110207 | ||
| 2 | IF_CNV_MBT_UNITTEST | Unit testing @ SLO | 20120911 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_CNV_00001_API_ABSTR_FIELD | 20110303 | Conv.-relevant field representation | |
| 2 | CL_CNV_00001_API_STATIC | 20110210 | Static CWB API implementation | |
| 3 | CL_CNV_00001_ROUTINE_TYPE_MAP | 20110218 | Map: type to routines for search activity | |
| 4 | CNV_00001_ROUTINES_TOOL | 20110304 | Routines suggestion tool |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CATEGORY |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_ROUTINE_CATEGORY | Category of the form routine (conv./aggr./priority) | 20110207 | ||
| 2 | CAT_AGGREGATE |
Constant | Public | Type reference (TYPE) | CNV_00001_ROUTINE_CATEGORY | 'A' | Aggregate routine | 20110216 | |
| 3 | CAT_CONVERSION |
Constant | Public | Type reference (TYPE) | CNV_00001_ROUTINE_CATEGORY | 'C' | Conversion routine | 20110216 | |
| 4 | CAT_PRIORITY |
Constant | Public | Type reference (TYPE) | CNV_00001_ROUTINE_CATEGORY | 'P' | Priority routine | 20110216 | |
| 5 | DOMS_DEFINED |
Instance attribute | Public | Type reference (TYPE) | FLAG | Whether routine is defined in CNVDOMS | 20110215 | ||
| 6 | DOMS_PARAMS_COUNT |
Instance attribute | Public | Type reference (TYPE) | INT2 | Routine parameter count according to CNVDOPARS | 20110316 | ||
| 7 | EXCLUDED_TYPES |
Instance attribute | Protected | Type reference (TYPE) | CNV_00001_T_CL_API_TYPEDEF | List of type definitions | 20110216 | ||
| 8 | FORMS_DEFINED |
Instance attribute | Public | Type reference (TYPE) | FLAG | Whether routine is defined in CNV_00001_FORMS | 20110215 | ||
| 9 | HELP_DOCU |
Instance attribute | Public | Type reference (TYPE) | DOKU_OBJ | Documentation Object | 20110216 | ||
| 10 | INCLUDE |
Instance attribute | Public | Type reference (TYPE) | CNV_PROG | Include where the routine is defined | 20110304 | ||
| 11 | NAME |
Instance attribute | Public | Type reference (TYPE) | CNV_FUNC | Name of the used routine | 20110207 | ||
| 12 | NONTRFIELD |
Instance attribute | Public | Type reference (TYPE) | CNVFIELDS-NONTRFIELD | Non-transparent field indicator | 20110503 | ||
| 13 | ORGDEP |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_ORGDEP | Routine org.-dependency flag | 20110305 | ||
| 14 | PACKID_SRC |
Instance attribute | Public | Type reference (TYPE) | CNV_SRCPACK | Number of source package | 20110222 | ||
| 15 | PARAMETERS |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_T_CL_API_PARAMETER | List of routine parameters | 20110207 | ||
| 16 | TYPE |
Instance attribute | Public | Type reference (TYPE) | CNV_TYPE | Conversion: Type of routine used | 20110207 | ||
| 17 | TYPEDEF |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_CNV_00001_API_TYPEDEF | Generic type definition | 20110216 | ||
| 18 | TYPEDEF_COND_PARAMS |
Instance attribute | Protected | Type reference (TYPE) | CNV_00001_HT_API_MAPRTYPEPTYPE | Condit. param. with types (depending on routine type def.) | 20110215 | ||
| 19 | TYPE_FMOD |
Constant | Public | Type reference (TYPE) | CNV_TYPE | 'U' | Function Module | 20140205 | |
| 20 | TYPE_FORM |
Constant | Public | Type reference (TYPE) | CNV_TYPE | 'F' | Form routine | 20110215 | |
| 21 | TYPE_MACRO |
Constant | Public | Type reference (TYPE) | CNV_TYPE | 'M' | Macro | 20140205 | |
| 22 | VISIBILITY |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_VISIBILITY | View mode ('E'-expert, 'C'-extended, ' '-standard) | 20110308 | ||
| 23 | VIS_EXPERT |
Constant | Public | Type reference (TYPE) | CNV_00001_VISIBILITY | 'E' | Visibility to expert | 20110216 | |
| 24 | VIS_EXTENDED |
Constant | Public | Type reference (TYPE) | CNV_00001_VISIBILITY | 'C' | Visibility to delivery service | 20110307 | |
| 25 | VIS_STANDARD |
Constant | Public | Type reference (TYPE) | CNV_00001_VISIBILITY | ' ' | Visibility to customer | 20110307 | |
| 26 | WHERE_USED_TABLES |
Instance attribute | Protected | Type reference (TYPE) | CNV_00001_T_CL_API_ABSTR_TABLE | List of conv.-relevant tables | 20110304 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_PARAMETER |
Instance method | Public | Method | Adds a parameter to the routine | 20110304 |
| 2 | ASSIGN_FIELD |
Instance method | Protected | Method | Assigns the field name to the parameter value | 20110311 |
| 3 | CHECK_VARIANT |
Instance method | Protected | Method | Checks one of the routine variants for suitability | 20110217 |
| 4 | CLEAR_PARAMETERS |
Instance method | Public | Method | Removes all the parametres | 20110415 |
| 5 | CLONE |
Instance method | Public | Method | Clones the routine object | 20110218 |
| 6 | CONSTRUCTOR |
Instance method | Public | Constructor | Creates a routine | 20110418 |
| 7 | EQUALS |
Instance method | Public | Method | 20110303 | |
| 8 | GET_ALL_ACCEPTED_TYPES |
Instance method | Public | Method | Returns types accepted by routine and corresp. param. types | 20110308 |
| 9 | GET_INCLUDE_OBJECT |
Instance method | Public | Method | Returns the include object | 20110419 |
| 10 | GET_PARAMETER |
Instance method | Public | Method | Returns the parameter with the given number | 20110304 |
| 11 | GET_UNKNOWN_ROUTINE |
Static method | Protected | Method | Returns a dummy routine used as 'unknown' routine | 20110303 |
| 12 | IS_UNKNOWN |
Instance method | Public | Method | Returns whether the routine is unknown | 20110303 |
| 13 | LOAD_FROM_STRUCTURE |
Instance method | Public | Method | 20110303 | |
| 14 | REMOVE_PARAMETER_TYPES |
Instance method | Protected | Method | Removes the types from the parameters | 20110216 |
| 15 | SET_CATEGORY |
Instance method | Public | Method | Sets routine category | 20131129 |
| 16 | SET_HELP_DOCU |
Instance method | Public | Method | Sets docu | 20131129 |
| 17 | SET_INCLUDE |
Instance method | Public | Method | Assigns the include | 20110307 |
| 18 | SET_NAME |
Instance method | Public | Method | Sets the routine name | 20110407 |
| 19 | SET_ORGDEP |
Instance method | Public | Method | Sets org. dependent flag | 20131129 |
| 20 | SET_PACKID_SRC |
Instance method | Public | Method | Sets the routine source package | 20110407 |
| 21 | SET_TYPE |
Instance method | Public | Method | Sets the routine type | 20110407 |
| 22 | SET_VISIBILITY |
Instance method | Public | Method | Sets visibility | 20131129 |
| 23 | STORE_IN_STRUCTURE |
Instance method | Public | Method | 20110303 | |
| 24 | TO_STRING |
Instance method | Public | Method | 20110303 | |
| 25 | WHERE_USED |
Instance method | Public | Method | Returns tables and fields where routine is used | 20110304 |
Events
Class CL_CNV_00001_API_ROUTINE has no event.
Types
Class CL_CNV_00001_API_ROUTINE has no local type.
Method Signatures
Method ADD_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
PARAMETER | Call by reference | Object reference (TYPE REF TO) | CL_CNV_00001_API_PARAMETER | Routine parameter | 20110304 |
Method ADD_PARAMETER on class CL_CNV_00001_API_ROUTINE has no exception.
Method ASSIGN_FIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
CLONED_PARAM | Call by reference | Object reference (TYPE REF TO) | CL_CNV_00001_API_PARAMETER | Routine parameter | 20110311 | ||
| 2 |  Changing |
EXCLUDED_FIELDS | Call by reference | Type reference (TYPE) | TTFIELDNAME | List of fields that should be excluded | 20110311 | ||
| 3 | Importing |
FIELDLIST | Call by reference | Type reference (TYPE) | DDFIELDS | Table field List | 20110311 | ||
| 4 | Importing |
FIELDNAME | Call by reference | Type reference (TYPE) | FIELDNAME | Name of the converted field | 20130517 | ||
| 5 | Exporting |
FOUND | Call by reference | Type reference (TYPE) | FLAG | Found suitable parameters | 20110311 | ||
| 6 | Importing |
ONLY_FIRST_SUITABLE | Call by reference | Type reference (TYPE) | FLAG | SPACE | General Flag | 20110311 | |
| 7 | Importing |
PARAM | Call by reference | Object reference (TYPE REF TO) | CL_CNV_00001_API_PARAMETER | Routine parameter | 20110311 | ||
| 8 | Exporting |
POTENTIAL_FOUND | Call by reference | Type reference (TYPE) | FLAG | Found potentially suitable parameters | 20110311 |
Method ASSIGN_FIELD on class CL_CNV_00001_API_ROUTINE has no exception.
Method CHECK_VARIANT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
EXCLUDED_FIELDS | Call by reference | Type reference (TYPE) | TTFIELDNAME | excluded fields | 20110217 | ||
| 2 | Importing |
FIELDNAME | Call by reference | Type reference (TYPE) | FIELDNAME | Name of the converted field | 20130517 | ||
| 3 | Importing |
FIELDS | Call by reference | Type reference (TYPE) | DDFIELDS | DD: Field List | 20110217 | ||
| 4 | Exporting |
FOUND | Call by reference | Type reference (TYPE) | FLAG | Found suitable parameters | 20110217 | ||
| 5 | Importing |
ONLY_FIRST_SUITABLE_FIELD | Call by reference | Type reference (TYPE) | FLAG | SPACE | whether to look for potentially suitable fields for paramete | 20110309 | |
| 6 | Exporting |
PARAMETERS | Call by reference | Type reference (TYPE) | CNV_00001_T_CL_API_PARAMETER | Found parameter values | 20110217 | ||
| 7 | Exporting |
POTENTIAL_FOUND | Call by reference | Type reference (TYPE) | FLAG | Found potentially suitable parameters | 20110222 | ||
| 8 | Importing |
TYPEPARAMS | Call by reference | Type reference (TYPE) | CNV_00001_T_CL_API_PARAMETER | Mapping: routine type definition->param. type definitions | 20110217 |
Method CHECK_VARIANT on class CL_CNV_00001_API_ROUTINE has no exception.
Method CLEAR_PARAMETERS Signature
Method CLEAR_PARAMETERS on class CL_CNV_00001_API_ROUTINE has no parameter.
Method CLEAR_PARAMETERS on class CL_CNV_00001_API_ROUTINE has no exception.
Method CLONE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PACKID_SRC | Call by reference | Type reference (TYPE) | CNV_SRCPACK | Number of source package | 20110303 | ||
| 2 |  Returning |
ROUTINE | Value transfer | Object reference (TYPE REF TO) | CL_CNV_00001_API_ROUTINE | Routine representation | 20110218 |
Method CLONE on class CL_CNV_00001_API_ROUTINE has no exception.
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_CNV_00001_API_ROUTINE has no parameter.
Method CONSTRUCTOR on class CL_CNV_00001_API_ROUTINE has no exception.
Method EQUALS Signature
Method EQUALS on class CL_CNV_00001_API_ROUTINE has no parameter.
Method EQUALS on class CL_CNV_00001_API_ROUTINE has no exception.
Method GET_ALL_ACCEPTED_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
TYPES | Value transfer | Type reference (TYPE) | CNV_00001_HT_API_MAPRTYPEPTYPE | List of routine type->param types mappings | 20110308 |
Method GET_ALL_ACCEPTED_TYPES on class CL_CNV_00001_API_ROUTINE has no exception.
Method GET_INCLUDE_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
INCL | Value transfer | Object reference (TYPE REF TO) | CL_CNV_00001_API_INCLUDE | Routine parameter | 20110419 |
Method GET_INCLUDE_OBJECT on class CL_CNV_00001_API_ROUTINE has no exception.
Method GET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
NUMBER | Call by reference | Type reference (TYPE) | CNV_PANUM | Conversion: consecutive number for a parameter | 20110304 | ||
| 2 | Returning |
PARAMETER | Value transfer | Object reference (TYPE REF TO) | CL_CNV_00001_API_PARAMETER | Routine parameter | 20110304 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_CNV_00001_API_NOT_FOUND |
Generic Not Found Error | 20110304 |
Method GET_UNKNOWN_ROUTINE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PACKID_SRC | Call by reference | Type reference (TYPE) | CNV_SRCPACK | Number of source package | 20110303 | ||
| 2 | Returning |
ROUTINE | Value transfer | Object reference (TYPE REF TO) | CL_CNV_00001_API_ROUTINE | Routine representation | 20110303 |
Method GET_UNKNOWN_ROUTINE on class CL_CNV_00001_API_ROUTINE has no exception.
Method IS_UNKNOWN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RET | Value transfer | Type reference (TYPE) | FLAG | General Flag | 20110303 |
Method IS_UNKNOWN on class CL_CNV_00001_API_ROUTINE has no exception.
Method LOAD_FROM_STRUCTURE Signature
Method LOAD_FROM_STRUCTURE on class CL_CNV_00001_API_ROUTINE has no parameter.
Method LOAD_FROM_STRUCTURE on class CL_CNV_00001_API_ROUTINE has no exception.
Method REMOVE_PARAMETER_TYPES Signature
Method REMOVE_PARAMETER_TYPES on class CL_CNV_00001_API_ROUTINE has no parameter.
Method REMOVE_PARAMETER_TYPES on class CL_CNV_00001_API_ROUTINE has no exception.
Method SET_CATEGORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CATEGORY | Call by reference | Type reference (TYPE) | CNV_00001_ROUTINE_CATEGORY | Category of the form routine (conv./aggr./priority) | 20131129 |
Method SET_CATEGORY on class CL_CNV_00001_API_ROUTINE has no exception.
Method SET_HELP_DOCU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
HELP_DOCU | Call by reference | Type reference (TYPE) | DOKU_OBJ | Documentation Object | 20131129 |
Method SET_HELP_DOCU on class CL_CNV_00001_API_ROUTINE has no exception.
Method SET_INCLUDE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
INCLUDE | Call by reference | Type reference (TYPE) | PROGNAME | ABAP program name | 20110307 |
Method SET_INCLUDE on class CL_CNV_00001_API_ROUTINE has no exception.
Method SET_NAME 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_FUNC | Name of the used routine | 20110407 |
Method SET_NAME on class CL_CNV_00001_API_ROUTINE has no exception.
Method SET_ORGDEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ORGDEP | Call by reference | Type reference (TYPE) | CNV_ORGDEPENDENT | Conversion: Organizational unit for delimitation | 20131129 |
Method SET_ORGDEP on class CL_CNV_00001_API_ROUTINE has no exception.
Method SET_PACKID_SRC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PACKID_SRC | Call by reference | Type reference (TYPE) | CNV_SRCPACK | Number of source package | 20110407 |
Method SET_PACKID_SRC on class CL_CNV_00001_API_ROUTINE has no exception.
Method SET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
TYPE | Call by reference | Type reference (TYPE) | CNV_TYPE | Conversion: Type of routine used | 20110407 |
Method SET_TYPE on class CL_CNV_00001_API_ROUTINE has no exception.
Method SET_VISIBILITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
VISIBILITY | Call by reference | Type reference (TYPE) | CNV_00001_VISIBILITY | View mode ('E'-expert, 'C'-extended, ' '-standard) | 20131129 |
Method SET_VISIBILITY on class CL_CNV_00001_API_ROUTINE has no exception.
Method STORE_IN_STRUCTURE Signature
Method STORE_IN_STRUCTURE on class CL_CNV_00001_API_ROUTINE has no parameter.
Method STORE_IN_STRUCTURE on class CL_CNV_00001_API_ROUTINE has no exception.
Method TO_STRING Signature
Method TO_STRING on class CL_CNV_00001_API_ROUTINE has no parameter.
Method TO_STRING on class CL_CNV_00001_API_ROUTINE has no exception.
Method WHERE_USED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
INCLUDE_INDX_TABLES | Call by reference | Type reference (TYPE) | FLAG | 'X' | Include INDX tabels | 20110304 | |
| 2 | Importing |
INCLUDE_NORM_TABLES | Call by reference | Type reference (TYPE) | FLAG | 'X' | Include normal tables | 20110304 | |
| 3 | Importing |
PACKID | Call by reference | Type reference (TYPE) | CNV_PACK | Conversion: Conversion package number | 20110304 | ||
| 4 | Returning |
TABLES | Value transfer | Type reference (TYPE) | CNV_00001_T_CL_API_ABSTR_TABLE | List of conv.-relevant tables | 20110304 |
Method WHERE_USED on class CL_CNV_00001_API_ROUTINE has no exception.
History
| Last changed by/on | SAP | 20141030 |
| SAP Release Created in | 2010_1_620 |
