SAP ABAP Class CL_BSP_DLC_DESIGN_LAYER_API (Design Layer API)

Hierarchy

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

Properties

Class	CL_BSP_DLC_DESIGN_LAYER_API
Short Description	Design Layer API
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	BSP_DYN_CONFIG_DESIGN	Design Layer
Created	20060607	SAP
Last change	20100303	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	BSPCD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_BSP_DLC_DESIGN_LAYER_API has no interface implemented.

Friends

Class CL_BSP_DLC_DESIGN_LAYER_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GR_DESIGN_LAYER_API	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_BSP_DLC_DESIGN_LAYER_API		Design Layer API	20060607

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COPY_DOBJ	Instance method	Public	Method	Copy design object from system table to customer table	20060612
2	COPY_VIEW_ASSIGNMENT	Instance method	Public	Method	Copy design object assignment from one view to another	20070608
3	DELETE_DESIGN	Instance method	Public	Method	Delete attributes from design in client dependent table	20060609
4	ENQUEUE	Instance method	Protected	Method	Enqueue	20060608
5	GET_INSTANCE	Static method	Public	Method	Creates an instance of the class	20060607
6	INVALIDATE_SHARED_MEMORY	Instance method	Public	Method	Invalidate shared memory area for design layer data	20070109
7	LOCK_DESIGN	Instance method	Public	Method	Lock design	20060608
8	READ_DASSIGN	Instance method	Public	Method	Read design object assignment table	20080122
9	READ_DESIGN	Instance method	Public	Method	Read design	20060608
10	READ_DESIGN_OBJECT	Instance method	Public	Method	Read design object	20080205
11	READ_DESIGN_SINGLE	Instance method	Public	Method	Read single design	20090312
12	READ_DOBJ	Instance method	Public	Method	Read design object	20060607
13	READ_DOBJ_ASSIGNMENTS	Instance method	Public	Method	Read design object assignment table	20090313
14	UNLOCK_DESIGN	Instance method	Public	Method	Unlock design	20060608
15	WHERE_USED_DOBJ	Instance method	Public	Method	Which context nodes have particular design object assigned?	20060608
16	WRITE_DESIGN	Instance method	Public	Method	Write design to client dependent table	20060609

Events

Class CL_BSP_DLC_DESIGN_LAYER_API has no event.

Types

Class CL_BSP_DLC_DESIGN_LAYER_API has no local type.

Method Signatures

Method COPY_DOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	do a COMMIT WORK AND WAIT	20060612
2	Importing	IV_DESIGN_OBJECT	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		Design layer: Design object	20060612
3	Importing	IV_INCLUDE_DESIGN	Call by reference	☐	Type reference (TYPE)	FLAG	'X'	also copy design settings	20060711
4	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060612
5	Importing	IV_TRANSPORT	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	Transport changes	20080409

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Error	20060612
2	NOT_FOUND	☐	Not found	20060612

Method COPY_VIEW_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	BSP_WD_COMPONENT_NAME		UI component name	20070608
2	Importing	IV_TRANSPORT	Call by reference	☐	Type reference (TYPE)	FLAG	'X'	Record changes to transport request?	20070608
3	Importing	IV_VIEWNAME_FROM	Call by reference	☐	Type reference (TYPE)	O2PAGE		Internal Name (Key) of BSP Page	20070608
4	Importing	IV_VIEWNAME_TO	Call by reference	☐	Type reference (TYPE)	O2PAGE		Internal Name (Key) of BSP Page	20070608

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Error	20070608

Method DELETE_DESIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTR_NAME_BOL	Call by reference	☑	Type reference (TYPE)	NAME_KOMP		Component name	20060609
2	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	do a COMMIT WORK AND WAIT	20060720
3	Importing	IV_DESIGN_OBJECT	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		Design layer: Design object	20060609
4	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060609

#	Exception	Resumable	Description	Created on
1	ERROR	☐	error	20060609

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTION	Call by reference	☐	Type reference (TYPE)	CHAR1	'E'	Action: E --> lock, D --> unlock	20060608
2	Importing	IV_DESIGN_OBJECT	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		Design object	20060608
3	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060608
4	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE		Source of design layer data: customer / SAP	20060608

#	Exception	Resumable	Description	Created on
1	ERROR	☐	other error	20060608
2	FOREIGN_LOCK	☐	locked by another user	20060608

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DESIGN_LAYER_API	Value transfer	☐	Object reference (TYPE REF TO)	CL_BSP_DLC_DESIGN_LAYER_API		Design Layer API	20060607

Method GET_INSTANCE on class CL_BSP_DLC_DESIGN_LAYER_API has no exception.

Method INVALIDATE_SHARED_MEMORY Signature

Method INVALIDATE_SHARED_MEMORY on class CL_BSP_DLC_DESIGN_LAYER_API has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Error	20070109

Method LOCK_DESIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DESIGN_OBJECT	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		Design object	20060608
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060608
3	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE		Source of design layer data: customer / SAP	20060608

#	Exception	Resumable	Description	Created on
1	ERROR	☐	other error	20060608
2	FOREIGN_LOCK	☐	locked by another user	20060608

Method READ_DASSIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ASSIGN_ENTRY	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_ASSIGN_ENTRY		Design layer: Design Assignment entry	20080122
2	Exporting	ET_ASSIGN_ENTRY	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_ASSIGN_ENTRYT		Design layer: Design Assignment entries	20080122
3	Importing	IV_ATTR_NAME_CN	Call by reference	☑	Type reference (TYPE)	NAME_KOMP		Component name	20080122
4	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	BSP_WD_COMPONENT_NAME		Component Name	20080122
5	Importing	IV_COMPONENT_USAGE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_COMPONENT_USAGE		Component Usage	20080122
6	Importing	IV_CONTEXT_NODE	Call by reference	☑	Type reference (TYPE)	SEOCMPNAME		Context Node	20080122
7	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20080122
8	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE	BSPCD_SOURCE_CUST_SAP	Source of design layer data: customer / SAP / both	20080122
9	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	O2PAGE		Internal Name (Key) of BSP Page	20080122

Method READ_DASSIGN on class CL_BSP_DLC_DESIGN_LAYER_API has no exception.

Method READ_DESIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DESIGN_ENTRY_SRC	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_ENTRY_SCR_T		Design layer: Design entries with sources	20060613
2	Importing	IT_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLCS_OBJ_TYPE_TT		Design layer: Object types	20060608
3	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20060608
4	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060608
5	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE	BSPCD_SOURCE_CUST_SAP	Source of design layer data: customer / SAP / both	20060608

Method READ_DESIGN on class CL_BSP_DLC_DESIGN_LAYER_API has no exception.

Method READ_DESIGN_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DESIGN_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_OBJECT_DATA		Data of Design Object	20080205
2	Exporting	ET_DESIGN_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_OBJECT_DATA_T		Data of Design Objects	20080226
3	Importing	IS_DESIGN_OBJECT	Call by reference	☑	Type reference (TYPE)	BSP_DLCS_OBJ_TYPE_DOBJ		Design Layer: Object types and design objects	20080205
4	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20080304
5	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20080226
6	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE	BSPCD_SOURCE_CUST_SAP	Source of design layer data: customer / SAP / both	20080205

Method READ_DESIGN_OBJECT on class CL_BSP_DLC_DESIGN_LAYER_API has no exception.

Method READ_DESIGN_SINGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DESIGN_ENTRY_SRC	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_ENTRY_SCR_T		Design layer: Design entries with sources	20090312
2	Importing	IV_DESIGN_OBJECT	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		Design Layer: Design Object	20090312
3	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20090312
4	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20090312
5	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE	BSPCD_SOURCE_CUST_SAP	Source of design layer data: customer / SAP / both	20090312

Method READ_DESIGN_SINGLE on class CL_BSP_DLC_DESIGN_LAYER_API has no exception.

Method READ_DOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECT_TYPE_DOBJ	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_OBJ_TYPE_DOBJ_TT		Design layer: Object types + design objects	20060607
2	Importing	IT_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_OBJ_TYPE_TT		Design layer: Object types	20060607
3	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE	BSPCD_SOURCE_CUST_SAP	Source of design layer data: customer / SAP / both	20060607

Method READ_DOBJ on class CL_BSP_DLC_DESIGN_LAYER_API has no exception.

Method READ_DOBJ_ASSIGNMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ASSIGN_ENTRY	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_ASSIGN_ENTRY		Design layer: Design Assignment entry	20090313
2	Exporting	ET_ASSIGN_ENTRY	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_ASSIGN_ENTRYT		Design layer: Design Assignment entries	20090313
3	Importing	IV_ATTR_NAME_CN	Call by reference	☑	Type reference (TYPE)	NAME_KOMP		Component name	20090313
4	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	BSP_WD_COMPONENT_NAME		Component Name	20090313
5	Importing	IV_COMPONENT_USAGE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_COMPONENT_USAGE		Component Usage	20090313
6	Importing	IV_CONTEXT_NODE	Call by reference	☑	Type reference (TYPE)	SEOCMPNAME		Context Node	20090313
7	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20090313
8	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE	BSPCD_SOURCE_CUST_SAP	Source of design layer data: customer / SAP / both	20090313
9	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	O2PAGE		Internal Name (Key) of BSP Page	20090313

Method READ_DOBJ_ASSIGNMENTS on class CL_BSP_DLC_DESIGN_LAYER_API has no exception.

Method UNLOCK_DESIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DESIGN_OBJECT	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		Design object	20060608
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060608
3	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE		Source of design layer data: customer / SAP	20060608

#	Exception	Resumable	Description	Created on
1	ERROR	☐	other error	20060608
2	FOREIGN_LOCK	☐	locked by another user	20060608

Method WHERE_USED_DOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ASSIGN_ENTRY	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_ASSIGN_ENTRYT		Design layer: Design Assignment entries	20060608
2	Exporting	ET_CONTEXT_NODE	Call by reference	☐	Type reference (TYPE)	CRMT_IC_CLASS		table for abap classes	20060608
3	Importing	IV_ATTR_NAME_BOL	Call by reference	☑	Type reference (TYPE)	NAME_KOMP		Component name	20060609
4	Importing	IV_DESIGN_OBJECT	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		Design layer: Design object	20060608
5	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060608
6	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE	BSPCD_SOURCE_CUST_SAP	Source of design layer data: customer / SAP / both	20060608

Method WHERE_USED_DOBJ on class CL_BSP_DLC_DESIGN_LAYER_API has no exception.

Method WRITE_DESIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DESIGN_ENTRY	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_DESIGN_ENTRY_T		Design layer: Design entries	20060609
2	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	do a COMMIT WORK AND WAIT	20060609
3	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20060609

#	Exception	Resumable	Description	Created on
1	ERROR	☐	ERROR	20060609

History

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