SAP ABAP Class CL_CNV_00001_API_PARAMETER (Routine parameter)
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 |
Properties
| Class | CL_CNV_00001_API_PARAMETER | |
| Short Description | Routine parameter | |
| 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 |  CL_CNV_00001_API_ROUTINE |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_CNV_00001_API_CUST_OBJECT | Abstract customizing object availabel in CWB API | 20110207 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_CNV_00001_API_ABSTR_FIELD | 20110418 | Conv.-relevant field representation | |
| 2 | CL_CNV_00001_API_ROUTINE | 20110216 | Routine representation | |
| 3 | CL_CNV_00001_API_STATIC | 20110210 | Static CWB API implementation |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | COND_VALUE |
Instance attribute | Public | Type reference (TYPE) | CNV_PARAM | Value for the search activity | 20110311 | ||
| 2 | DFIES_POSITION |
Instance attribute | Public | Type reference (TYPE) | DFIES-POSITION | Position of the field in the table | 20110309 | ||
| 3 | EXCLUDED_TYPEDEFS |
Instance attribute | Protected | Type reference (TYPE) | CNV_00001_T_CL_API_TYPEDEF | List of excluded type definitions | 20110216 | ||
| 4 | HELP_DOCU |
Instance attribute | Public | Type reference (TYPE) | DOKU_OBJ | Documentation Object | 20110216 | ||
| 5 | NUMBER |
Instance attribute | Public | Type reference (TYPE) | CNV_PANUM | Conversion: consecutive number for a parameter | 20110207 | ||
| 6 | POTENT_SUITABLE_VALUES |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_T_PARAM | List of potentially suitable parameter values | 20110222 | ||
| 7 | SUITABLE_VALUES |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_T_PARAM | List of suitable parameter values | 20110222 | ||
| 8 | TYPE |
Instance attribute | Public | Type reference (TYPE) | CNV_PATYPE | Conversion: Type of parameter for a conversion routine | 20110207 | ||
| 9 | TYPEDEFS |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_T_CL_API_TYPEDEF | List of type definitions | 20110215 | ||
| 10 | TYPE_FIXEDVAL |
Constant | Public | Type reference (TYPE) | CNV_PATYPE | 'F' | Parameter type: fixed value | 20110217 | |
| 11 | TYPE_TABFIELD |
Constant | Public | Type reference (TYPE) | CNV_PATYPE | 'T' | Parameter type: table field | 20110217 | |
| 12 | TYPE_VARIABLE |
Constant | Public | Type reference (TYPE) | CNV_PATYPE | 'V' | Parameter type: variable | 20110217 | |
| 13 | VALTYPE_FIXED |
Constant | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | 'F' | Fixed value | 20110311 | |
| 14 | VALTYPE_PARDOMA |
Constant | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | 'D' | Domain of another parameter (number of param in VALUE) | 20110311 | |
| 15 | VALTYPE_PARDTEL |
Constant | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | 'R' | Data element of another parameter (number of param in VALUE) | 20110311 | |
| 16 | VALTYPE_PARFIELD |
Constant | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | 'C' | Field name of another parameter (number of param in VALUE) | 20110311 | |
| 17 | VALTYPE_TABFIELD |
Constant | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | SPACE | Field of the table | 20110311 | |
| 18 | VALTYPE_TABFIELD_FIXED |
Constant | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | 'G' | Global variable of the conversion program | 20110311 | |
| 19 | VALTYPE_TABFIELD_VAR |
Constant | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | 'W' | Global var. of the conv. prog.; if not found - fixed value | 20110311 | |
| 20 | VALTYPE_VAR |
Constant | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | 'V' | Field of the table; if not found - fixed value | 20110311 | |
| 21 | VALUE |
Instance attribute | Public | Type reference (TYPE) | CNV_PARAM | Conversion: Value of a parameter for a conversion routine | 20110207 | ||
| 22 | VALUE_TYPE |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | Type of parameter value for search activity | 20110311 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_TABTYPE_FIELDNAME |
Instance method | Public | Method | Checks the name of the field used as parameter | 20110322 |
| 2 | CLONE |
Instance method | Public | Method | Clones the parameter | 20110217 |
| 3 | EQUALS |
Instance method | Public | Method | 20110303 | |
| 4 | FIND_SUITABLE_FIELDS |
Instance method | Public | Method | Finds suitable field of the given table to be used as param. | 20110222 |
| 5 | IS_VALUE_SUITABLE |
Instance method | Public | Method | Returns the suitability of the given value | 20110307 |
| 6 | LOAD_FROM_STRUCTURE |
Instance method | Public | Method | 20110303 | |
| 7 | SET_COND_VALUE |
Instance method | Public | Method | Sets the 'conditional' value | 20110407 |
| 8 | SET_HELP_DOCU |
Instance method | Public | Method | Sets docu | 20131129 |
| 9 | SET_NUMBER |
Instance method | Public | Method | Sets parameter number | 20131129 |
| 10 | SET_TYPE |
Instance method | Public | Method | Sets the parameter type | 20110304 |
| 11 | SET_VALUE |
Instance method | Public | Method | Sets the parameter value | 20110304 |
| 12 | SET_VALUE_TYPE |
Instance method | Public | Method | Sets the value type | 20110407 |
| 13 | STORE_IN_STRUCTURE |
Instance method | Public | Method | 20110303 | |
| 14 | TO_STRING |
Instance method | Public | Method | 20110303 |
Events
Class CL_CNV_00001_API_PARAMETER has no event.
Types
Class CL_CNV_00001_API_PARAMETER has no local type.
Method Signatures
Method CHECK_TABTYPE_FIELDNAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
LOGGER | Call by reference | Object reference (TYPE REF TO) | CL_CNV_MBT_ULV_LOGGER | ULV Logger | 20110322 | ||
| 2 | Importing |
LOGGER_LEVEL | Call by reference | Type reference (TYPE) | BALLEVEL | '1' | Logger level | 20110328 | |
| 3 | Importing |
PACK | Call by reference | Object reference (TYPE REF TO) | CL_CNV_00001_API_PACKAGE | Representation of the package | 20110322 | ||
| 4 | Importing |
ROUTINE | Call by reference | Object reference (TYPE REF TO) | CL_CNV_00001_API_ROUTINE | Routine representation | 20110322 | ||
| 5 |  Returning |
STATUS | Value transfer | Type reference (TYPE) | MSGTY | Status | 20110322 | ||
| 6 | Importing |
TABLE | Call by reference | Object reference (TYPE REF TO) | CL_CNV_00001_API_TABLE | Table representation | 20110322 |
Method CHECK_TABTYPE_FIELDNAME on class CL_CNV_00001_API_PARAMETER has no exception.
Method CLONE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PARAM | Value transfer | Object reference (TYPE REF TO) | CL_CNV_00001_API_PARAMETER | Routine parameter | 20110217 |
Method CLONE on class CL_CNV_00001_API_PARAMETER has no exception.
Method EQUALS Signature
Method EQUALS on class CL_CNV_00001_API_PARAMETER has no parameter.
Method EQUALS on class CL_CNV_00001_API_PARAMETER has no exception.
Method FIND_SUITABLE_FIELDS 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 | List of fields that should be excluded | 20110222 | ||
| 2 | Importing |
FIELDLIST | Call by reference | Type reference (TYPE) | DDFIELDS | Table field List | 20110222 | ||
| 3 |  Exporting |
FIELDS | Call by reference | Type reference (TYPE) | DDFIELDS | Suitable fields | 20110222 | ||
| 4 | Importing |
ONLY_FIRST_SUITABLE | Call by reference | Type reference (TYPE) | FLAG | SPACE | General Flag | 20110309 | |
| 5 | Exporting |
POTENTIAL_FIELDS | Call by reference | Type reference (TYPE) | DDFIELDS | Potentially suitable fields | 20110222 |
Method FIND_SUITABLE_FIELDS on class CL_CNV_00001_API_PARAMETER has no exception.
Method IS_VALUE_SUITABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
POTENTIALLY_SUITABLE | Call by reference | Type reference (TYPE) | FLAG | General Flag | 20110307 | ||
| 2 | Exporting |
SUITABLE | Call by reference | Type reference (TYPE) | FLAG | General Flag | 20110307 | ||
| 3 | Exporting |
UNKNOWN | Call by reference | Type reference (TYPE) | FLAG | General Flag | 20110307 | ||
| 4 | Importing |
VALUE | Call by reference | Type reference (TYPE) | CNV_PARAM | Conversion: Value of a parameter for a conversion routine | 20110307 |
Method IS_VALUE_SUITABLE on class CL_CNV_00001_API_PARAMETER has no exception.
Method LOAD_FROM_STRUCTURE Signature
Method LOAD_FROM_STRUCTURE on class CL_CNV_00001_API_PARAMETER has no parameter.
Method LOAD_FROM_STRUCTURE on class CL_CNV_00001_API_PARAMETER has no exception.
Method SET_COND_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
COND_VALUE | Call by reference | Type reference (TYPE) | CNVDOPARS-VALUE | Conversion: Value of a parameter for a conversion routine | 20110407 |
Method SET_COND_VALUE on class CL_CNV_00001_API_PARAMETER 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_PARAMETER has no exception.
Method SET_NUMBER 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 | 20131129 |
Method SET_NUMBER on class CL_CNV_00001_API_PARAMETER 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_PATYPE | Conversion: Type of parameter for a conversion routine | 20110304 |
Method SET_TYPE on class CL_CNV_00001_API_PARAMETER has no exception.
Method SET_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
VALUE | Call by reference | Type reference (TYPE) | CNV_PARAM | Conversion: Value of a parameter for a conversion routine | 20110304 |
Method SET_VALUE on class CL_CNV_00001_API_PARAMETER has no exception.
Method SET_VALUE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
VALUE_TYPE | Call by reference | Type reference (TYPE) | CNV_00001_PARAM_VALUE_TYPE | Type of parameter value for search activity | 20110407 |
Method SET_VALUE_TYPE on class CL_CNV_00001_API_PARAMETER has no exception.
Method STORE_IN_STRUCTURE Signature
Method STORE_IN_STRUCTURE on class CL_CNV_00001_API_PARAMETER has no parameter.
Method STORE_IN_STRUCTURE on class CL_CNV_00001_API_PARAMETER has no exception.
Method TO_STRING Signature
Method TO_STRING on class CL_CNV_00001_API_PARAMETER has no parameter.
Method TO_STRING on class CL_CNV_00001_API_PARAMETER has no exception.
History
| Last changed by/on | SAP | 20141030 |
| SAP Release Created in | 2010_1_620 |
