SAP ABAP Interface IF_BSP_DLC_CONFIGURATION (Configuration Descriptor Interface)
Hierarchy
☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-UI-RT (Application Component) UI Runtime Environment
     ⤷ BSP_DYN_CONFIG_RUNTIME (Package) Runtime Support for Dynamic Layout
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_BSP_DLC_CONFIGURATION Configuratiion Runtime Object 20050915
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_BSP_DLC_CONFIGURATION2 Configuration Runtime Object 20060421
Properties
Interface IF_BSP_DLC_CONFIGURATION  
Short Description Configuration Descriptor Interface    
General Data
Package BSP_DYN_CONFIG_RUNTIME   Runtime Support for Dynamic Layout 
Created 20050915   SAP 
Last changed 20110908   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)
2 BSPCD Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Interface IF_BSP_DLC_CONFIGURATION has no interface.
Friends
Interface IF_BSP_DLC_CONFIGURATION has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MODE_DISPLAY Constant Public Type reference (TYPE) BSP_DLC_DISP_EDIT_MODE 'D' Display Mode 20070710
2 MODE_EDIT Constant Public Type reference (TYPE) BSP_DLC_DISP_EDIT_MODE 'E' Edit mode 20070710
Methods
# Method Level Visibility Method type Description Created on
1 DELETE_CONFIG_DATA Instance method Public Method 20051104
2 DELETE_CUSTOM_TEXT Instance method Public Method 20051104
3 GET_CONFIG_DATA Instance method Public Method 20051018
4 GET_CONFIG_DATA_EXPLICIT Instance method Public Method Get explicitly (no access sequence) 20070831
5 GET_CURRENT_CONFIG_DATA_INFO Instance method Public Method Get info about current config data 20090423
6 GET_CURRENT_CONFIG_DATA_ORIGIN Instance method Public Method Get origin of current config data (System or Customer Table) 20060713
7 GET_CURRENT_CONTEXT_ID Instance method Public Method Get current context id 20060517
8 GET_CUSTOM_TEXT Instance method Public Method Liefert Texte aus der Konfiguration 20051019
9 GET_CUSTOM_TEXT_W_INFO Instance method Public Method Liefert Texte aus der Konfiguration 20100531
10 GET_MANDATORY_FIELDS Instance method Public Method 20060607
11 GET_PROPERTY_DESCRIPTOR Instance method Public Method 20051018
12 LOCK_CONFIGURATION Instance method Public Method 20051026
13 SET_COMPONENT_USAGE Instance method Public Method 20060405
14 SET_CONFIG_DATA Instance method Public Method 20051024
15 SET_CUSTOM_TEXT Instance method Public Method 20051024
16 SET_FIELD_PROPERTIES Instance method Public Method 20051102
17 SET_ROLE_KEY Instance method Public Method 20060405
18 SET_SUBKEY Instance method Public Method 20051028
19 SET_TRANSPORT_DATA Instance method Public Method 20060118
20 UNLOCK_CONFIGURATION Instance method Public Method 20051026
21 WAS_INVALIDATED Instance method Public Method At runtime: Was invalidated since last call of this meth 20090205
Events
# Event Type Visibility Description Created on
1 CONFIG_CHANGED Instance Event
(0) 		Public
(2) 		Configuration changed 20070612
2 CONFIG_DATA_CHANGED Static Event
(1) 		Public
(2) 		Configuration changed 20060727
Types
Interface IF_BSP_DLC_CONFIGURATION has no local type.
Method Signatures

Method DELETE_CONFIG_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ALL_SUBKEYS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Delete for all subkeys 20051111
2 Importing IV_PERSONALIZATION_FOR_USER Call by reference Type reference (TYPE) SY-UNAME ' ' Call from personalization 20060421
# Exception Resumable Description Created on
1 ERROR_OCCURRED 20051104

Method DELETE_CUSTOM_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ALL_SUBKEYS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Delete for all subkeys 20051111
2 Importing IV_ELEMENT_ID Call by reference Type reference (TYPE) BSP_DLC_ELEMENT_ID Generic element ID for short text elements 20051104
3 Importing IV_LANGU Call by reference Type reference (TYPE) SYLANGU Language Key of Current Text Environment 20051104
# Exception Resumable Description Created on
1 ERROR_OCCURRED 20051104

Method GET_CONFIG_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_4_EDIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20051024
2 Importing IV_FOR_DISPLAY_MODE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Get Config for display mode 20070719
3 Importing IV_FOR_TABLE_LAYOUT_PERS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE get all table layouts 20091125
4 Importing IV_PERS_ONLY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE personalization data only 20060626
5 Importing IV_WITHOUT_PERS Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE Depricated / Don't use 20060419
6 Returning RV_RESULT Value transfer Type reference (TYPE) BSP_DLC_XML String for XML storage 20051018
# Exception Resumable Description Created on
1 CONFIG_NOT_FOUND 20060601
2 FOREIGN_LOCK 20060601

Method GET_CONFIG_DATA_EXPLICIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_4_EDIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20070831
2 Importing IV_RET_PERS_IF_EXIST Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Return personalization, if existing 20070831
3 Importing IV_SKIP_ACCESS_SEQ Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Skip access sequence 20070831
4 Importing IV_SOURCE Call by reference Type reference (TYPE) BSP_DLC_DESIGN_LAYER_SOURCE BSPCD_SOURCE_CUST_SAP Source of Configuration Data: Customer / SAP / Both 20100701
5 Returning RV_RESULT Value transfer Type reference (TYPE) BSP_DLC_XML String for XML storage 20070831
# Exception Resumable Description Created on
1 CONFIG_NOT_FOUND 20070831
2 FOREIGN_LOCK 20070831
3 PARAMETER_ERROR Current state of importing parameters not supported 20100701

Method GET_CURRENT_CONFIG_DATA_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) BSP_DLCS_CUR_CONFIG_INFO From System- or Customer-Table 20090423

Method GET_CURRENT_CONFIG_DATA_INFO on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method GET_CURRENT_CONFIG_DATA_ORIGIN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) BSP_DLC_CONFIG_DATA_ORIGIN From System- or Customer-Table 20060713

Method GET_CURRENT_CONFIG_DATA_ORIGIN on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method GET_CURRENT_CONTEXT_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) BSP_DLC_CONTEXT_ID Context ID 20060517

Method GET_CURRENT_CONTEXT_ID on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method GET_CUSTOM_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ELEMENT_ID Call by reference Type reference (TYPE) CHAR70 Characterfeld der Länge 70 20051019
2 Importing IV_LANGU Call by reference Type reference (TYPE) SPRAS SY-LANGU Language Key 20100720
3 Importing IV_SOURCE Value transfer Type reference (TYPE) BSP_DLC_DESIGN_LAYER_SOURCE BSPCD_SOURCE_CUST_SAP Source of Design Layer Data: Customer / SAP / Both 20070404
4 Returning RV_TEXT Value transfer Type reference (TYPE) STRING 20051019

Method GET_CUSTOM_TEXT on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method GET_CUSTOM_TEXT_W_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_TEXT Call by reference Type reference (TYPE) STRING Text 20100531
2 Exporting EV_TEXT_ORIGIN Call by reference Type reference (TYPE) BSP_DLC_LABEL_ORIGIN Text Origin 20100531
3 Importing IV_ELEMENT_ID Call by reference Type reference (TYPE) CHAR70 Characterfeld der Länge 70 20100531
4 Importing IV_LANGU Call by reference Type reference (TYPE) SPRAS SY-LANGU Language Key 20100720
5 Importing IV_SOURCE Value transfer Type reference (TYPE) BSP_DLC_DESIGN_LAYER_SOURCE BSPCD_SOURCE_CUST_SAP Source of Design Layer Data: Customer / SAP / Both 20100531

Method GET_CUSTOM_TEXT_W_INFO on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method GET_MANDATORY_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_MANDATORY_FIELDS Value transfer Type reference (TYPE) BSP_DLCT_FIELDNAME 20060607

Method GET_MANDATORY_FIELDS on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method GET_PROPERTY_DESCRIPTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMPONENT_NAME Call by reference Type reference (TYPE) BSP_WD_COMPONENT_NAME Component Name (When explicitly needed) 20090609
2 Returning RV_RESULT Value transfer Object reference (TYPE REF TO) IF_BSP_DLC_VIEW_DESCRIPTOR View Descriptor Interface 20051018

Method GET_PROPERTY_DESCRIPTOR on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method LOCK_CONFIGURATION Signature

Method LOCK_CONFIGURATION on Interface IF_BSP_DLC_CONFIGURATION has no parameter.
# Exception Resumable Description Created on
1 FOREIGN_LOCK 20051026

Method SET_COMPONENT_USAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMPONENT_USAGE Call by reference Type reference (TYPE) BSP_DLC_COMPONENT_USAGE Component Usage 20060405

Method SET_COMPONENT_USAGE on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method SET_CONFIG_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_CHANGED_EVENT_PARAMETERS Value transfer Type reference (TYPE) TIHTTPNVP Parameters of CHANGED event 20071113
2 Importing IV_ATTRIB_DATA Call by reference Type reference (TYPE) BSP_DLC_XML Attribute XML 20070126
3 Importing IV_BUTTON_CONFIG_DATA Call by reference Type reference (TYPE) BSP_DLC_XML Button Config XML 20091027
4 Importing IV_CONFIG_DATA Value transfer Type reference (TYPE) BSP_DLC_XML String for XML Storage 20051024
5 Importing IV_PERSONALIZATION_FOR_USER Call by reference Type reference (TYPE) SY-UNAME ' ' Call from personalization 20060420

Method SET_CONFIG_DATA on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method SET_CUSTOM_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ELEMENT_ID Call by reference Type reference (TYPE) BSP_DLC_ELEMENT_ID Generic element ID for short text elements 20051024
2 Importing IV_LANGU Call by reference Type reference (TYPE) SPRAS SY-LANGU Language Key 20100721
3 Importing IV_TEXT Call by reference Type reference (TYPE) TEXT128 Work Area Length 128 20051024

Method SET_CUSTOM_TEXT on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method SET_FIELD_PROPERTIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ELEMENT_ID Call by reference Type reference (TYPE) BSP_DLC_ELEMENT_ID Generic element ID for short text elements 20051102
2 Importing IV_HIDDEN Call by reference Type reference (TYPE) ABAP_BOOL 20051102

Method SET_FIELD_PROPERTIES on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method SET_ROLE_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ROLE_KEY Call by reference Type reference (TYPE) BSP_DLC_ROLE_KEY Role key 20060405

Method SET_ROLE_KEY on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method SET_SUBKEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SUBKEY Call by reference Type reference (TYPE) BSP_DLC_SUBKEY Generic Subkey 20051028

Method SET_SUBKEY on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method SET_TRANSPORT_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TRANSPORT_DATA Call by reference Type reference (TYPE) STRING Transport data 20060120

Method SET_TRANSPORT_DATA on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method UNLOCK_CONFIGURATION Signature

Method UNLOCK_CONFIGURATION on Interface IF_BSP_DLC_CONFIGURATION has no parameter.
Method UNLOCK_CONFIGURATION on Interface IF_BSP_DLC_CONFIGURATION has no exception.

Method WAS_INVALIDATED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20090205

Method WAS_INVALIDATED on Interface IF_BSP_DLC_CONFIGURATION has no exception.
Event Signatures

Event CONFIG_CHANGED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 PARAMETERS Exporting Value transfer Type reference (TYPE) TIHTTPNVP Parameters of CHANGED event 20071113

Event CONFIG_DATA_CHANGED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 PARAMETERS Exporting Value transfer Type reference (TYPE) TIHTTPNVP Parameters of CHANGED event 20071113
2 VIEWNAME Exporting Value transfer Type reference (TYPE) STRING Viewname 20060727
History
Last changed by/on SAP  20110908 
SAP Release Created in 700