SAP ABAP Class CL_BSP_DLC_CONFIG_API (Configuration API Factory)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-CON (Application Component) UI Configuration & Design Layer
     ⤷ BSP_DYN_CONFIG_TOOLS2_CORE (Package) Config Tools Core

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BSP_DLC_CONFIG_API_GRID	API for grid configuration	20070326
2	Inheritance (c INHERITING FROM c_ref)	CL_BSP_DLC_CONFIG_API_TABLE	Api for table configuration	20070329

Properties

Class	CL_BSP_DLC_CONFIG_API
Short Description	Configuration API Factory
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	BSP_DYN_CONFIG_TOOLS2_CORE	Config Tools Core
Created	20070326	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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	CL_BSP_DLC_XML_STORAGE2	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_BSP_DLC_CONFIG_API has no interface implemented.

Friends

Class CL_BSP_DLC_CONFIG_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONFIG_KEY	Instance attribute	Protected	☐	Type reference (TYPE)	BSP_DCLS_CONF_SEMANTIC_KEY		Config key	20070330
2	GR_CONF_DESCR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_BSP_DLC_CONFIGURATION		Configuration Descriptor Interface	20070326
3	GR_VIEW_DESCR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_BSP_DLC_VIEW_DESCRIPTOR		View Descriptor Interface	20070326
4	GT_LOCKS	Static Attribute	Private	☐	Type reference (TYPE)	TT_LOCKS			20070330
5	MESSAGE_SERVICE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_BSP_DLC_CONFIG_API_MESSAGES			20070327

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20070326
2	DELETE_CONFIG	Instance method	Public	Method		20070420
3	GET_API	Static method	Public	Method		20070326
4	GET_CONFIG_INFO_FOR_VIEW	Static method	Public	Method	Gets info regarding the existing configurations for a view	20070405
5	IS_OWN_LOCKED	Instance method	Protected	Method	Is locked (own lock)	20070404
6	LOCK	Instance method	Public	Method		20070326
7	READ_CONFIG_XML	Instance method	Protected	Method		20070329
8	SAVE_CONFIG_XML	Instance method	Protected	Method		20070329
9	TRANSPORT_CONFIG	Instance method	Public	Method		20070327
10	UNLOCK	Instance method	Public	Method		20070326

Events

Class CL_BSP_DLC_CONFIG_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_LOCKS	Private	See coding			20070330	tt_locks TYPE sorted table of BSP_DCLS_CONF_SEMANTIC_KEY with unique key table_line

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	BSP_DCLS_CONF_SEMANTIC_KEY		Config semantic key	20070330

Method CONSTRUCTOR on class CL_BSP_DLC_CONFIG_API has no exception.

Method DELETE_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070420
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20070420
3	Importing	IV_SUPPRESS_TRANSPORT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20070420

Method DELETE_CONFIG on class CL_BSP_DLC_CONFIG_API has no exception.

Method GET_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_API	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_DLC_CONFIG_API		Configuration API	20070327
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070327
3	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		True if successful	20070329
4	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	BSP_WD_COMPONENT_NAME		Component Name	20070326
5	Importing	IV_COMPONENT_USAGE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_COMPONENT_USAGE	CL_BSP_DLC_XML_STORAGE2=>DEFAULT_COMPONENT_USAGE	Component Usage	20070326
6	Importing	IV_OBJECT_SUB_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_SUB_TYPE	CL_BSP_DLC_XML_STORAGE2=>DEFAULT_OBJECT_SUB_TYPE	Object Subtype	20070326
7	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE	CL_BSP_DLC_XML_STORAGE2=>DEFAULT_OBJECT_TYPE	UI Object Type	20070326
8	Importing	IV_ROLE_KEY	Call by reference	☐	Type reference (TYPE)	BSP_DLC_ROLE_KEY	CL_BSP_DLC_XML_STORAGE2=>DEFAULT_ROLE_KEY	Role Configuration Key	20070326
9	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	O2PAGEEXT		Name of BSP Page (Upper and Lower Case)	20070330

Method GET_API on class CL_BSP_DLC_CONFIG_API has no exception.

Method GET_CONFIG_INFO_FOR_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONFIG_INFO	Call by reference	☐	Type reference (TYPE)	BSP_DLCT_CONFIG_INFO		Configuration info	20070405
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070405
3	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20070405
4	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	BSP_WD_COMPONENT_NAME		Component Name	20070405
5	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	O2PAGEEXT		Name of BSP Page (Upper and Lower Case)	20070405

Method GET_CONFIG_INFO_FOR_VIEW on class CL_BSP_DLC_CONFIG_API has no exception.

Method IS_OWN_LOCKED 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			20070404

Method IS_OWN_LOCKED on class CL_BSP_DLC_CONFIG_API has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ALREADY_LOCKED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		True if already locked	20070330
2	Exporting	EV_LOCKED_BY	Call by reference	☐	Type reference (TYPE)	SYUNAME		User Name	20070327
3	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		True if successful	20070329

Method LOCK on class CL_BSP_DLC_CONFIG_API has no exception.

Method READ_CONFIG_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONFIG_ORIGIN	Call by reference	☐	Type reference (TYPE)	BSP_DLC_CONFIG_DATA_ORIGIN		From System- or Customer Table	20070329
2	Exporting	EV_CONFIG_XML	Call by reference	☐	Type reference (TYPE)	STRING			20070329

Method READ_CONFIG_XML on class CL_BSP_DLC_CONFIG_API has no exception.

Method SAVE_CONFIG_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20070420
2	Importing	IV_CONFIG_XML	Call by reference	☐	Type reference (TYPE)	STRING			20070329
3	Importing	IV_SUPPRESS_TRANSPORT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20070329

Method SAVE_CONFIG_XML on class CL_BSP_DLC_CONFIG_API has no exception.

Method TRANSPORT_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070329
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20070329
3	Importing	IV_TRANSPORT_REQUEST	Call by reference	☑	Type reference (TYPE)	TRKORR		Transport Request	20070330

Method TRANSPORT_CONFIG on class CL_BSP_DLC_CONFIG_API has no exception.

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NOT_LOCKED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070330
2	Exporting	EV_SUCCESS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		True if successful	20070329

Method UNLOCK on class CL_BSP_DLC_CONFIG_API has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	700