SAP ABAP Class CL_FPM_CONFIG_READER (Configuration Reader for OIF)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
⤷
APB_FPM_CORE (Package) Floorplan Manager (Framework)
⤷
⤷
Meta Relationship - Used By
Properties
| Class | CL_FPM_CONFIG_READER | |
| Short Description | Configuration Reader for OIF | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | APB_FPM_CORE | Floorplan Manager (Framework) |
| Created | 20090102 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_FPM_CONFIG_READER has no interface implemented.
Friends
Class CL_FPM_CONFIG_READER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | STRING | 'INITIAL_SCREEN' | 20090102 | |||
| 2 | Constant | Public | Type reference (TYPE) | STRING | 'VARIANT' | 20090102 | |||
| 3 | Instance attribute | Public | Type reference (TYPE) | STRING | 20110902 | ||||
| 4 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_ABAP_DATADESCR | Runtime Type Services | 20090102 | |||
| 5 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_ABAP_DATADESCR | Runtime Type Services | 20100505 | |||
| 6 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_ABAP_DATADESCR | Runtime Type Services | 20090102 | |||
| 7 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_WD_CONFIG_APPL_READER | Read Interface for Application Configuration | 20090107 | |||
| 8 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_WD_CONFIG_COMP_READER | Read Interface for the Component Configuration | 20090102 | |||
| 9 | Instance attribute | Protected | Type reference (TYPE) | TY_S_INITIAL_SCREEN | 20090102 | ||||
| 10 | Instance attribute | Protected | Type reference (TYPE) | WDY_CFG_CHGTOOL_NODE_INFO_MAP | WD Configuration, Change Tool, List of Node Details | 20090102 | |||
| 11 | Instance attribute | Protected | Type reference (TYPE) | TY_T_QUICKVIEW_INT | 20120227 | ||||
| 12 | Instance attribute | Protected | Type reference (TYPE) | TY_T_VARIANT | 20090102 | ||||
| 13 | Instance attribute | Public | Type reference (TYPE) | WDY_CONFIG_ID | Configuration Identification | 20090105 | |||
| 14 | Instance attribute | Private | Type reference (TYPE) | WDY_CONFIG_TYPE | Type of Web Dynpro Configuration | 20090107 | |||
| 15 | Instance attribute | Private | Type reference (TYPE) | STRING | 20090102 | ||||
| 16 | Instance attribute | Public | Type reference (TYPE) | STRING | 20100505 | ||||
| 17 | Instance attribute | Public | Type reference (TYPE) | STRING | 20100506 | ||||
| 18 | Instance attribute | Private | Type reference (TYPE) | STRING | 20090102 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | CONSTRUCTOR | 20090102 | |
| 2 | Static method | Public | Method | 20090102 | ||
| 3 | Instance method | Private | Method | 20090102 | ||
| 4 | Instance method | Private | Method | 20090102 | ||
| 5 | Instance method | Protected | Method | 20090102 | ||
| 6 | Instance method | Protected | Method | 20100505 | ||
| 7 | Instance method | Protected | Method | 20090102 | ||
| 8 | Instance method | Private | Method | 20090102 | ||
| 9 | Instance method | Protected | Method | 20140519 | ||
| 10 | Instance method | Private | Method | 20140519 | ||
| 11 | Instance method | Public | Method | 20110902 | ||
| 12 | Instance method | Protected | Method | Return a List of Context Menus | 20111222 | |
| 13 | Instance method | Protected | Method | Items of a context menu | 20111222 |
Events
Class CL_FPM_CONFIG_READER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_S_CTXT_MENU | Public | Type reference (TYPE) | CL_FPM_CONFIG_WRITER=>TY_S_CTXT_MENU | 20111222 | |
|
| 2 | TY_S_CTXT_MENU_ITEM | Public | Type reference (TYPE) | CL_FPM_CONFIG_WRITER=>TY_S_CTXT_MENU_ITEM | 20111222 | |
|
| 3 | TY_S_INITIAL_SCREEN | Public | See coding | 20090102 | BEGIN OF ty_s_initial_screen,
id TYPE string,
name TYPE string,
path TYPE string,
END OF ty_s_initial_screen
|
||
| 4 | TY_S_QUICKVIEW_INT | Protected | See coding | 20120227 | begin of ty_s_quickview_int.
INCLUDE TYPE cl_fpm_config_writer=>ty_s_quickview.
types: path type string,
end of ty_s_quickview_int
|
||
| 5 | TY_S_VARIANT | Public | See coding | 20090102 | BEGIN OF ty_s_variant,
id TYPE string,
name TYPE string,
path TYPE string,
END OF ty_s_variant
|
||
| 6 | TY_T_CTXT_MENU | Public | Type reference (TYPE) | CL_FPM_CONFIG_WRITER=>TY_T_CTXT_MENU | 20111222 | |
|
| 7 | TY_T_CTXT_MENU_ITEM | Public | Type reference (TYPE) | CL_FPM_CONFIG_WRITER=>TY_T_CTXT_MENU_ITEM | 20111222 | |
|
| 8 | TY_T_QUICKVIEW_INT | Protected | See coding | 20120227 | ty_t_quickview_int TYPE STANDARD TABLE OF ty_s_quickview_int
|
||
| 9 | TY_T_VARIANT | Public | See coding | 20090102 | ty_t_variant TYPE STANDARD TABLE OF ty_s_variant
|
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_APPL_READER | Call by reference | Object reference (TYPE REF TO) | IF_WD_CONFIG_APPL_READER | Read Interface for Application Configuration | 20090107 | |||
| 2 | IR_COMP_READER | Call by reference | Object reference (TYPE REF TO) | IF_WD_CONFIG_COMP_READER | Read Interface for the Component Configuration | 20090102 | |||
| 3 | IV_CONFIGURATION_ID | Call by reference | Type reference (TYPE) | WDY_CONFIG_ID | Configuration Identification | 20090105 | |||
| 4 | IV_CONFIG_TYPE | Call by reference | Type reference (TYPE) | WDY_CONFIG_TYPE | Type of Web Dynpro Configuration | 20090107 | |||
| 5 | IV_NO_VARIANTS | Call by reference | Type reference (TYPE) | BOOLE_D | ABAP_FALSE | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090115 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Floorplan exceptions | 20090121 |
Method CONVERT_I_TO_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_STRING | Value transfer | Type reference (TYPE) | STRING | 20090102 | ||||
| 2 | IV_INTEGER | Call by reference | Type reference (TYPE) | I | 20090102 |
Method CONVERT_I_TO_STRING on class CL_FPM_CONFIG_READER has no exception.
Method CREATE_INITIAL_SCREEN_NODE_ID Signature
Method CREATE_INITIAL_SCREEN_NODE_ID on class CL_FPM_CONFIG_READER has no parameter.
Method CREATE_INITIAL_SCREEN_NODE_ID on class CL_FPM_CONFIG_READER has no exception.
Method CREATE_VARIANT_NODE_ID Signature
Method CREATE_VARIANT_NODE_ID on class CL_FPM_CONFIG_READER has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Floorplan exceptions | 20090105 |
Method GET_INITIAL_SCREEN Signature
Method GET_INITIAL_SCREEN on class CL_FPM_CONFIG_READER has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Floorplan exceptions | 20090105 |
Method GET_NODE_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_COUNT | Call by reference | Type reference (TYPE) | I | 20100517 | ||||
| 2 | EV_STRUCTURE | Call by reference | Type reference (TYPE) | ANY | 20100505 | ||||
| 3 | IV_NODE_NAME | Call by reference | Type reference (TYPE) | STRING | 20100505 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Floorplan exceptions | 20100527 |
Method GET_STRUCTURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_STRUCTURE | Value transfer | Object reference (TYPE REF TO) | CL_ABAP_DATADESCR | Runtime Type Services | 20090102 | |||
| 2 | IV_NODE_NAME | Call by reference | Type reference (TYPE) | STRING | 20090102 |
Method GET_STRUCTURE on class CL_FPM_CONFIG_READER has no exception.
Method GET_VARIANTS Signature
Method GET_VARIANTS on class CL_FPM_CONFIG_READER has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Floorplan exceptions | 20090105 |
Method READ_CONFIGURATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_CONFIG | Call by reference | Type reference (TYPE) | DATA | 20140519 | ||||
| 2 | IV_APPL_NODE_NAME | Call by reference | Type reference (TYPE) | STRING | 20140519 |
Method READ_CONFIGURATION on class CL_FPM_CONFIG_READER has no exception.
Method READ_ELEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_DATA | Call by reference | Type reference (TYPE) | ANY | 20140519 | ||||
| 2 | IV_INDEX | Call by reference | Type reference (TYPE) | I | 1 | 20140519 | |||
| 3 | IV_NODE_ID | Call by reference | Type reference (TYPE) | STRING | 20140519 | ||||
| 4 | IV_NODE_NAME | Call by reference | Type reference (TYPE) | STRING | 20140519 |
Method READ_ELEMENT on class CL_FPM_CONFIG_READER has no exception.
Method SET_COMPONENT_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_COMPONENT_NAME | Call by reference | Type reference (TYPE) | STRING | 20110902 |
Method SET_COMPONENT_NAME on class CL_FPM_CONFIG_READER has no exception.
Method _GET_CTXT_MENU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_CTXT_MENU | Value transfer | Type reference (TYPE) | TY_T_CTXT_MENU | 20111222 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Floorplan exceptions | 20111222 |
Method _GET_CTXT_MENU_ITEM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CTXT_MENU_ID | Call by reference | Type reference (TYPE) | FPM_CTXT_MENU_ID | Context Menu ID | 20111222 | |||
| 2 | RT_CTXT_MENU_ITEM | Value transfer | Type reference (TYPE) | TY_T_CTXT_MENU_ITEM | 20111222 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Personalization Error | 20111222 |
Meta Relationship - Used By (full list)
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 720 |