SAP ABAP Interface IF_CPF_PARAMETERS (Interface for CPF Formula parameter handling)
Hierarchy
☛
PI_BASIS (Software Component) Basis Plug-In
⤷
CA-GTF-PR-CPF (Application Component) Configurable Parameters and Formulas
⤷
CPF_BASIS (Package) Configurable Parameters and Formulas (Basis)
PI_BASIS (Software Component) Basis Plug-In⤷
CA-GTF-PR-CPF (Application Component) Configurable Parameters and Formulas⤷
CPF_BASIS (Package) Configurable Parameters and Formulas (Basis)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CPF_PARAMETERS | CPF: Formula parameters | 20120726 |
Properties
| Interface | IF_CPF_PARAMETERS | |
| Short Description | Interface for CPF Formula parameter handling |
General Data
| Package | CPF_BASIS | Configurable Parameters and Formulas (Basis) |
| Created | 20120726 | SAP |
| Last changed | 20131127 | SAP |
| 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) |
Interfaces
Interface IF_CPF_PARAMETERS has no interface.
Friends
Interface IF_CPF_PARAMETERS has no friend.
Attributes
Interface IF_CPF_PARAMETERS has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_ALL_PARAMETERS |
Instance method | Public | Method | Returns a list of all parameters | 20120823 |
| 2 | GET_ALL_SCALES |
Instance method | Public | Method | Returns a list of all scales | 20130114 |
| 3 | GET_CHANGED_FLAG |
Instance method | Public | Method | Checks if parameter data were changed | 20130320 |
| 4 | GET_PARAMETER |
Instance method | Public | Method | Returns a parameter (with value) | 20120823 |
| 5 | GET_PARAMETER_DESCRIPTION |
Instance method | Public | Method | Returns short and long description of parameter | 20121212 |
| 6 | GET_PARAMETER_INFO |
Instance method | Public | Method | Get infos about a parameter (data type and category, compon) | 20121009 |
| 7 | GET_PARAMETER_SCALE |
Instance method | Public | Method | Returns parameter scale (with value) | 20130111 |
| 8 | REMOVE_PARAMETER |
Instance method | Public | Method | Removes a parameter and its value | 20130305 |
| 9 | REMOVE_PARAMETER_SCALE |
Instance method | Public | Method | Remove a scale assigned to a parameter | 20130425 |
| 10 | SET_CHANGED_FLAG |
Instance method | Public | Method | Sets the changed flag | 20130320 |
| 11 | SET_PARAMETER |
Instance method | Public | Method | Add/modify a parameter (with value or not) | 20120823 |
| 12 | SET_PARAMETER_SCALE |
Instance method | Public | Method | Add/modify parameter scale (with value or not) | 20130111 |
Events
Interface IF_CPF_PARAMETERS has no event.
Types
Interface IF_CPF_PARAMETERS has no local type.
Method Signatures
Method GET_ALL_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RT_PARAMETER | Value transfer | Type reference (TYPE) | CPFT_PARAMETER | Table type for CPF parameter | 20120823 |
Method GET_ALL_PARAMETERS on Interface IF_CPF_PARAMETERS has no exception.
Method GET_ALL_SCALES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_SCALE | Value transfer | Type reference (TYPE) | CPFT_OBJ_SCALE | Table type for CPF Scale with values | 20130114 |
Method GET_ALL_SCALES on Interface IF_CPF_PARAMETERS has no exception.
Method GET_CHANGED_FLAG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_CHANGED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20130320 |
Method GET_CHANGED_FLAG on Interface IF_CPF_PARAMETERS has no exception.
Method GET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_PARAMETER | Call by reference | Type reference (TYPE) | CPF_PARAMETER_NAME | CPF parameter name | 20120823 | ||
| 2 | Importing |
IV_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SUBPARAMETER | ' ' | CPF Subparameter | 20120823 | |
| 3 | Returning |
RO_VALUE | Value transfer | Object reference (TYPE REF TO) | DATA | FDT: Elementary Data Type Text (SSTRING) | 20120823 |
Method GET_PARAMETER on Interface IF_CPF_PARAMETERS has no exception.
Method GET_PARAMETER_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_DESCRIPTION | Call by reference | Type reference (TYPE) | CHAR30 | Concatenated short description | 20121212 | ||
| 2 | Exporting |
EV_DESCRIPTION_LONG | Call by reference | Type reference (TYPE) | CHAR70 | Concatenated long description | 20121212 | ||
| 3 | Importing |
IV_ONLY_CATALOG | Call by reference | Type reference (TYPE) | XFELD | ' ' | Only from catalog | 20130104 | |
| 4 | Importing |
IV_ONLY_TASK | Call by reference | Type reference (TYPE) | XFELD | ' ' | Only from task | 20130104 | |
| 5 | Importing |
IV_PARAMETER | Call by reference | Type reference (TYPE) | CPF_PARAMETER_NAME | CPF Parameter Name | 20121212 | ||
| 6 | Importing |
IV_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SUBPARAMETER | ' ' | CPF Subparameter | 20121212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_CPF |
Exception for CPF | 20130320 |
Method GET_PARAMETER_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_COMPONENTS | Call by reference | Type reference (TYPE) | CPFT_CUSSTRUCC | Table type for CPF Custom Structure Component | 20121009 | ||
| 2 | Exporting |
EV_DATA_CATEGORY | Call by reference | Type reference (TYPE) | CPF_DATA_CATEGORY | CPF Data Category | 20121009 | ||
| 3 | Exporting |
EV_DATA_TYPE | Call by reference | Type reference (TYPE) | CPF_REF_DATA_TYPE | CPF Data Type | 20121009 | ||
| 4 | Exporting |
EV_DS_ROUTINE | Call by reference | Type reference (TYPE) | CPF_DS_ROUTINE | CPF Data Source Routine | 20121211 | ||
| 5 | Importing |
IV_ONLY_CATALOG | Call by reference | Type reference (TYPE) | XFELD | ' ' | Only look for catalog parameters | 20130104 | |
| 6 | Importing |
IV_ONLY_TASK | Call by reference | Type reference (TYPE) | XFELD | ' ' | Only look for task parameters | 20130104 | |
| 7 | Importing |
IV_PARAMETER | Call by reference | Type reference (TYPE) | CPF_PARAMETER_NAME | CPF parameter name | 20121009 | ||
| 8 | Importing |
IV_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SUBPARAMETER | ' ' | CPF Subparameter | 20121009 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CPF |
CPF error | 20130320 | |
| 2 | CX_CPF_NOTHING_FOUND |
Nothing was found | 20130320 |
Method GET_PARAMETER_SCALE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PARAMETER | Call by reference | Type reference (TYPE) | CPF_PARAMETER_NAME | CPF parameter name | 20130111 | ||
| 2 | Importing |
IV_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SUBPARAMETER | ' ' | CPF Subparameter | 20130111 | |
| 3 | Returning |
RS_SCALE | Value transfer | Type reference (TYPE) | CPFS_OBJ_SCALE | CPF Scale with values | 20130111 |
Method GET_PARAMETER_SCALE on Interface IF_CPF_PARAMETERS has no exception.
Method REMOVE_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PARAMETER | Call by reference | Type reference (TYPE) | CPF_PARAMETER_NAME | Parameter Name | 20130305 | ||
| 2 | Importing |
IV_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SUBPARAMETER | Subparameter | 20130305 |
Method REMOVE_PARAMETER on Interface IF_CPF_PARAMETERS has no exception.
Method REMOVE_PARAMETER_SCALE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PARAMETER | Call by reference | Type reference (TYPE) | CPF_PARAMETER_NAME | Parameter Name | 20130425 | ||
| 2 | Importing |
IV_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SUBPARAMETER | ' ' | Subparameter | 20130425 |
Method REMOVE_PARAMETER_SCALE on Interface IF_CPF_PARAMETERS has no exception.
Method SET_CHANGED_FLAG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CHANGED | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20130320 |
Method SET_CHANGED_FLAG on Interface IF_CPF_PARAMETERS has no exception.
Method SET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_VALUE | Value transfer | Object reference (TYPE REF TO) | DATA | Value | 20120823 | ||
| 2 | Importing |
IV_DATACATEGORY | Call by reference | Type reference (TYPE) | CPF_DATA_CATEGORY | CPF Data Category | 20120828 | ||
| 3 | Importing |
IV_DATA_TYPE | Call by reference | Type reference (TYPE) | CPF_REF_DATA_TYPE | CPF Referenced Data Type | 20121227 | ||
| 4 | Importing |
IV_DS_ROUTINE | Call by reference | Type reference (TYPE) | CPF_DS_ROUTINE | CPF Data Source Routine | 20121211 | ||
| 5 | Importing |
IV_PARAMETER | Call by reference | Type reference (TYPE) | CPF_PARAMETER_NAME | CPF parameter name | 20120823 | ||
| 6 | Importing |
IV_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SUBPARAMETER | ' ' | CPF Subparameter | 20120823 |
Method SET_PARAMETER on Interface IF_CPF_PARAMETERS has no exception.
Method SET_PARAMETER_SCALE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_BASE_VALUE | Value transfer | Object reference (TYPE REF TO) | DATA | Base Value | 20130111 | ||
| 2 | Importing |
IO_START_ASC_SCALE | Call by reference | Object reference (TYPE REF TO) | DATA | 20130415 | |||
| 3 | Importing |
IO_START_DESC_SCALE | Call by reference | Object reference (TYPE REF TO) | DATA | Start value of descending scale part | 20130415 | ||
| 4 | Importing |
IT_SCALE_LINES | Call by reference | Type reference (TYPE) | CPFT_OBJ_SCALE_LINE | Table type for CPF Scale Line with values | 20130111 | ||
| 5 | Importing |
IV_BASE_PARAMETER | Call by reference | Type reference (TYPE) | CPF_SCALE_BASE_PARAMETER | CPF Base Parameter Name | 20130111 | ||
| 6 | Importing |
IV_BASE_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SCALE_BASE_SUBPARAMETER | CPF Assigned Subparameter | 20130111 | ||
| 7 | Importing |
IV_RESULT_PARAMETER | Call by reference | Type reference (TYPE) | CPF_SCALE_RESULT_PARAMETER | 20130415 | |||
| 8 | Importing |
IV_RESULT_SUBPARAMETER | Call by reference | Type reference (TYPE) | CPF_SCALE_RESULT_SUBPARAMETER | ' ' | 20130415 | ||
| 9 | Importing |
IV_SCALE_DISABLED | Call by reference | Type reference (TYPE) | CPF_SCALE_DISABLED | CPF Scale Disabled in Document | 20130415 | ||
| 10 | Importing |
IV_SCALE_EVAL_ROUT | Call by reference | Type reference (TYPE) | CPF_SCALE_EVAL_ROUTINE | CPF Scale Evaluation Routine | 20130111 | ||
| 11 | Importing |
IV_SCALE_LEVEL_CURRENCY | Call by reference | Type reference (TYPE) | CPF_SCALE_LEVEL_CURRENCY | Scale Level Currency | 20130415 | ||
| 12 | Importing |
IV_SCALE_LEVEL_PRICE_UNIT | Call by reference | Type reference (TYPE) | CPF_SCALE_LEVEL_PRICE_UNIT | Scale Level Price Unit | 20130415 | ||
| 13 | Importing |
IV_SCALE_LEVEL_UNIT | Call by reference | Type reference (TYPE) | CPF_SCALE_LEVEL_UNIT | Scale Level UoM | 20130415 | ||
| 14 | Importing |
IV_SCALE_LEVEL_VAL_CURRENCY | Call by reference | Type reference (TYPE) | CPF_SCALE_LEVEL_VAL_CURRENCY | Scale Level Value Currency | 20130415 | ||
| 15 | Importing |
IV_SCALE_LEVEL_VAL_PRICE_UNIT | Call by reference | Type reference (TYPE) | CPF_SCALE_LEVEL_VAL_PRICE_UNIT | Scale Level Value Price Unit | 20130415 | ||
| 16 | Importing |
IV_SCALE_LEVEL_VAL_UNIT | Call by reference | Type reference (TYPE) | CPF_SCALE_LEVEL_VAL_UNIT | Scale Level Value UoM | 20130415 | ||
| 17 | Importing |
IV_SCALE_TYPE | Call by reference | Type reference (TYPE) | CPF_SCALE_TYPE | CPF Scale Type | 20130415 |
Method SET_PARAMETER_SCALE on Interface IF_CPF_PARAMETERS has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 740 |
