SAP ABAP Interface IF_BSP_DLC_VIEW_DESCRIPTOR (View 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_VIEW_DESCRIPTOR View Descriptor 20051018
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CRM_WS_BOL_FILTER_EXTRACTOR Extracts exclusion tables for webservice filter 20080331
Properties
Interface IF_BSP_DLC_VIEW_DESCRIPTOR  
Short Description View 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_VIEW_DESCRIPTOR has no interface.
Friends
Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 FIELD_TYPE_CHECKBOX Constant Public Type reference (TYPE) CHAR1 'C' Single-Character Flag 20060630
2 FIELD_TYPE_COMMUNICATIONLINK Constant Public Type reference (TYPE) CHAR1 'B' Communication Link 20080320
3 FIELD_TYPE_EINPUT Constant Public Type reference (TYPE) CHAR1 'E' Single-Character Flag 20060630
4 FIELD_TYPE_EVENT_LINK Constant Public Type reference (TYPE) CHAR1 'H' Single-Character Flag 20060630
5 FIELD_TYPE_IMAGE Constant Public Type reference (TYPE) CHAR1 'G' Single-Character Flag 20060630
6 FIELD_TYPE_INPUT Constant Public Type reference (TYPE) CHAR1 'I' Single-Character Flag 20060630
7 FIELD_TYPE_LINK Constant Public Type reference (TYPE) CHAR1 'L' Single-Character Flag 20060630
8 FIELD_TYPE_OCA Constant Public Type reference (TYPE) CHAR1 'O' OneClickActions field type 20060630
9 FIELD_TYPE_PASSWORD Constant Public Type reference (TYPE) CHAR1 'U' Password 20060704
10 FIELD_TYPE_PICKLIST Constant Public Type reference (TYPE) CHAR1 'P' Single-Character Flag 20060630
11 FIELD_TYPE_RADIO Constant Public Type reference (TYPE) CHAR1 'R' Single-Character Flag 20060630
12 FIELD_TYPE_TEXT Constant Public Type reference (TYPE) CHAR1 'T' Single-Character Flag 20060630
13 FIELD_TYPE_TEXTAREA Constant Public Type reference (TYPE) CHAR1 'A' Textarea 20060630
14 FIELD_TYPE_TIMEPICKER Constant Public Type reference (TYPE) CHAR1 'Z' Time Picker 20060712
15 LABEL_ORIGIN_DDIC Constant Public Type reference (TYPE) BSP_DLC_LABEL_ORIGIN 'DD' Dictionary 20070219
16 LABEL_ORIGIN_DESIGN_LAYER Constant Public Type reference (TYPE) BSP_DLC_LABEL_ORIGIN 'DL' Design Layer (SAP) 20070219
17 LABEL_ORIGIN_DESIGN_LAYER_CUST Constant Public Type reference (TYPE) BSP_DLC_LABEL_ORIGIN 'DC' Design Layer (Customer) 20070411
18 LABEL_ORIGIN_NONE Constant Public Type reference (TYPE) BSP_DLC_LABEL_ORIGIN 'NO' None 20070219
19 LABEL_ORIGIN_TEXT_REP Constant Public Type reference (TYPE) BSP_DLC_LABEL_ORIGIN 'TR' Text Repository (SAP) / Default Configuraton 20070219
20 LABEL_ORIGIN_TEXT_REP_CUST Constant Public Type reference (TYPE) BSP_DLC_LABEL_ORIGIN 'TC' Text Repository (Customer) / Default Configuraton 20070411
21 LABEL_ORIGIN_TEXT_REP_CUS_NDEF Constant Public Type reference (TYPE) BSP_DLC_LABEL_ORIGIN 'T2' Text Repository (Customer) / non-default configuration 20100531
22 LABEL_ORIGIN_TEXT_REP_NDEF Constant Public Type reference (TYPE) BSP_DLC_LABEL_ORIGIN 'T1' Text Repository (SAP) / non-default configuration 20100531
Methods
# Method Level Visibility Method type Description Created on
1 GET_ACTION_DL Instance method Public Method Returns Action Provider ID from Design Layer 20090312
2 GET_ALL_FIELDS Instance method Public Method 20051018
3 GET_ALL_TABLE_FIELDS Instance method Public Method 20051018
4 GET_CONTEXT_NODES Instance method Public Method 20051019
5 GET_DT_RT_REP Instance method Public Method Get Design Time RT-Rep 20090630
6 GET_FIELD_DESIGN_LAYER Instance method Public Method Get Design Layer information for field 20080121
7 GET_FIELD_DISABLED_DL Instance method Public Method Is field disabled in design layer? 20060407
8 GET_FIELD_GEN_VALUEHELP_DL Instance method Public Method Generic value help in design layer? 20060630
9 GET_FIELD_HIDDEN_DL Instance method Public Method Is field hidden in design layer? 20060412
10 GET_FIELD_LABEL Instance method Public Method 20051025
11 GET_FIELD_LABELS Instance method Public Method 20051018
12 GET_FIELD_LABEL_ORIGIN Instance method Public Method 20070219
13 GET_FIELD_MANDATORY_DL Instance method Public Method Is field mandatory in design layer? 20060407
14 GET_FIELD_SFW_DATA Instance method Public Method 20080506
15 GET_FIELD_TYPE Instance method Public Method 20051018
16 GET_FIELD_TYPE_DL Instance method Public Method Field type in design layer? 20060630
17 GET_FIELD_TYPE_TEXT Instance method Public Method 20051018
18 GET_HIDDEN_FIELDS Instance method Public Method CoD only! 20051103
19 GET_PERS_ABLE_TABLE_FIELDS Instance method Public Method Get visible and personalizable table fields for personalizat 20060405
20 GET_REFERENCE_FIELD_DL Instance method Public Method Returns the Reference BOL Attribute from Design Layer 20080506
21 GET_STEXT_REPOSITORY Instance method Public Method 20051018
22 GET_STEXT_REPOSITORY2 Instance method Public Method 20060410
23 GET_TABLE_CNODE_NAME Instance method Public Method 20051027
24 GET_VIEWAREAS Instance method Public Method 20051018
25 GET_VISIBLE_FIELDS Instance method Public Method 20051018
26 GET_VISIBLE_TABLE_FIELDS Instance method Public Method 20051018
27 SET_SUBKEY Instance method Public Method 20051018
Events
Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no event.
Types
Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no local type.
Method Signatures

Method GET_ACTION_DL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_ACTION_PROV_ID Call by reference Type reference (TYPE) WCF_AC_PROVIDER_ID Action Provider Id 20090312
2 Exporting EV_ACTION_RELATION Call by reference Type reference (TYPE) WCF_AC_RELATION_NAME BOL Relation Name 20090511
3 Importing IV_FIELDNAME Call by reference Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20090312
# Exception Resumable Description Created on
1 CX_BSP_DLC_DESIGN_NOT_FOUND Design not found 20090312

Method GET_ALL_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_ALL_FIELDS Value transfer Type reference (TYPE) BSP_DLCT_FIELD Used Fiels 20051018

Method GET_ALL_FIELDS on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_ALL_TABLE_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FULL_FIELD_NAMES Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20051020
2 Returning RT_ALL_FIELDS Value transfer Type reference (TYPE) BSP_DLCT_FIELD Used Fiels 20051018

Method GET_ALL_TABLE_FIELDS on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_CONTEXT_NODES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_RESULT Value transfer Type reference (TYPE) CRMT_BSP_WD_ELEM_DESCR_TAB Table of BSP WD Element Descriptions 20051019

Method GET_CONTEXT_NODES on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_DT_RT_REP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Object reference (TYPE REF TO) CL_BSP_WD_REPOSITORY Web Dynpro Runtime Repository 20090630

Method GET_DT_RT_REP on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_FIELD_DESIGN_LAYER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_DESIGN_OBJECT Call by reference Type reference (TYPE) BSP_DLCS_OBJ_TYPE_DOBJ Design Layer: Object types and design objects 20080121
2 Exporting EV_DSGN_ATTR_NAME Call by reference Type reference (TYPE) NAME_KOMP Design Object Attribute 20080624
3 Exporting EV_IS_REFERENCE Call by reference Type reference (TYPE) FLAG Is Reference Design Object 20080305
4 Importing IV_ELEMENT_ID Call by reference Type reference (TYPE) BSP_DLC_ELEMENT_ID Generic element ID for short text elements 20080121

Method GET_FIELD_DESIGN_LAYER on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_FIELD_DISABLED_DL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FIELDNAME Value transfer Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20060407
2 Returning RV_DISABLED Value transfer Type reference (TYPE) BSP_DLC_DISPLAY_ONLY Display Only 20060407
# Exception Resumable Description Created on
1 CX_BSP_DLC_DESIGN_NOT_FOUND Design not found 20060412

Method GET_FIELD_GEN_VALUEHELP_DL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FIELDNAME Value transfer Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20060630
2 Returning RV_ENABLED Value transfer Type reference (TYPE) ABAP_BOOL gener. Valuehelp enabled 20060630
# Exception Resumable Description Created on
1 CX_BSP_DLC_DESIGN_NOT_FOUND Design not found 20060630

Method GET_FIELD_HIDDEN_DL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FIELDNAME Value transfer Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20060412
2 Returning RV_HIDDEN Value transfer Type reference (TYPE) ABAP_BOOL Hidden 20060412
# Exception Resumable Description Created on
1 CX_BSP_DLC_DESIGN_NOT_FOUND Design not found 20060412

Method GET_FIELD_LABEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONTEXT_NODE Call by reference Object reference (TYPE REF TO) CL_BSP_WD_CONTEXT_NODE 20060714
2 Importing IV_ELEMENT_ID Call by reference Type reference (TYPE) BSP_DLC_ELEMENT_ID Generic element ID for short text elements 20051025
3 Importing IV_LANGU Call by reference Type reference (TYPE) SPRAS SY-LANGU Language Key of Current Text Environment 20100720
4 Importing IV_SKIP_TEXT_REPOSITORY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Skip reading of text repository 20070411
5 Returning RV_RESULT Value transfer Type reference (TYPE) STRING 20051025

Method GET_FIELD_LABEL on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_FIELD_LABELS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_FIELDS Call by reference Type reference (TYPE) BSP_DLCT_FIELD Fields 20051018
2 Importing IV_LANGU Call by reference Type reference (TYPE) SPRAS SY-LANGU Language Key of Current Text Environment 20100720

Method GET_FIELD_LABELS on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_FIELD_LABEL_ORIGIN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONTEXT_NODE Call by reference Object reference (TYPE REF TO) CL_BSP_WD_CONTEXT_NODE WD Context Node 20070219
2 Importing IV_ELEMENT_ID Call by reference Type reference (TYPE) BSP_DLC_ELEMENT_ID Generic element ID for short text elements 20070219
3 Importing IV_LANGU Call by reference Type reference (TYPE) SPRAS SY-LANGU Language Key of Current Text Environment 20100720
4 Importing IV_SKIP_TEXT_REPOSITORY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Skip reading of text repository 20070411
5 Returning RV_RESULT Value transfer Type reference (TYPE) BSP_DLC_LABEL_ORIGIN Origin of label (Design Layer, DDIC, Text Repository) 20070219

Method GET_FIELD_LABEL_ORIGIN on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_FIELD_MANDATORY_DL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FIELDNAME Value transfer Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20060407
2 Returning RV_MANDATORY Value transfer Type reference (TYPE) BSP_DLC_DISPLAY_ONLY Mandatory 20060407
# Exception Resumable Description Created on
1 CX_BSP_DLC_DESIGN_NOT_FOUND Design not found 20060412

Method GET_FIELD_SFW_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_REACTION Call by reference Type reference (TYPE) SFW_SHOWHIDE Reaction to Switch 20080506
2 Exporting EV_SWITCH_ID Call by reference Type reference (TYPE) SFW_SWITCH_ID Id of a Switch in Switch Framework 20080506
3 Importing IV_CONTEXT_NODE Call by reference Object reference (TYPE REF TO) CL_BSP_WD_CONTEXT_NODE 20080506
4 Importing IV_FIELDNAME Call by reference Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20080506

Method GET_FIELD_SFW_DATA on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_FIELD_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONTEXT_NODE Call by reference Object reference (TYPE REF TO) CL_BSP_WD_CONTEXT_NODE 20060714
2 Importing IV_FIELDNAME Call by reference Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20051018
3 Importing IV_NO_GETTER Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20080612
4 Returning RV_RESULT Value transfer Type reference (TYPE) CHAR1 Single-Character Flag 20051018

Method GET_FIELD_TYPE on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_FIELD_TYPE_DL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FIELDNAME Value transfer Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20060630
2 Returning RV_TYPE Value transfer Type reference (TYPE) BSP_DLC_FIELD_TYPE Field Type on UI (Input field, Dropdown Listbox, ...) 20060630
# Exception Resumable Description Created on
1 CX_BSP_DLC_DESIGN_NOT_FOUND Design not found 20060630

Method GET_FIELD_TYPE_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TYPE Call by reference Type reference (TYPE) CHAR1 Field Type 20051018
2 Returning RV_RESULT Value transfer Type reference (TYPE) STRING 20051018

Method GET_FIELD_TYPE_TEXT on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_HIDDEN_FIELDS Signature

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

Method GET_HIDDEN_FIELDS on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_PERS_ABLE_TABLE_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting RT_AVAILABLE_FIELDS Value transfer Type reference (TYPE) BSP_DLCT_FIELD Fields 20060405
2 Exporting RT_VISIBLE_FIELDS Value transfer Type reference (TYPE) BSP_DLC_COLUMN_DESCR_TAB Table column definitions 20060405
# Exception Resumable Description Created on
1 CONFIG_NOT_FOUND Configuration was not found 20060405

Method GET_REFERENCE_FIELD_DL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_ATTR_NAME Call by reference Type reference (TYPE) NAME_KOMP BOL Object Attribute Name 20080506
2 Exporting EV_OBJECT_NAME Call by reference Type reference (TYPE) CRMT_EXT_OBJ_NAME External Name of Object 20080506
3 Importing IV_FIELDNAME Value transfer Type reference (TYPE) BSP_DLC_BINDING_STRING Binding String 20080506
# Exception Resumable Description Created on
1 CX_BSP_DLC_DESIGN_NOT_FOUND Design not found 20080506

Method GET_STEXT_REPOSITORY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RESULT Value transfer Object reference (TYPE REF TO) CL_BSP_DLC_STEXT_REPOSITORY Text repository 20051018

Method GET_STEXT_REPOSITORY on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_STEXT_REPOSITORY2 Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RESULT Value transfer Object reference (TYPE REF TO) CL_BSP_DLC_STEXT_REPOSITORY2 Text repository 20060410

Method GET_STEXT_REPOSITORY2 on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_TABLE_CNODE_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RESULT Value transfer Type reference (TYPE) STRING Context node name 20051027

Method GET_TABLE_CNODE_NAME on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_VIEWAREAS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPLICATION Call by reference Object reference (TYPE REF TO) CL_BSP_WD_APPLICATION BSP WD Application 20051018
2 Returning RT_RESULT Value transfer Type reference (TYPE) BSP_DLC_VIEWAREA_DESCR_TAB 20051018

Method GET_VIEWAREAS on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_VISIBLE_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_VISIBLE_FIELDS Value transfer Type reference (TYPE) BSP_DLCT_FIELD Visible Fields 20051018

Method GET_VISIBLE_FIELDS on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.

Method GET_VISIBLE_TABLE_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FULL_FIELD_NAMES Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20051020
2 Returning RT_VISIBLE_FIELDS Value transfer Type reference (TYPE) BSP_DLCT_FIELD Visible Fields 20051018

Method GET_VISIBLE_TABLE_FIELDS on Interface IF_BSP_DLC_VIEW_DESCRIPTOR 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 20051018

Method SET_SUBKEY on Interface IF_BSP_DLC_VIEW_DESCRIPTOR has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 700