SAP ABAP Class CL_WS_DESIGN_LAYER_API (Design Layer API)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-WST (Application Component) Web Services Tool
     ⤷ WS_BOL_WEB_UI_API (Package) Communication Layer between Design layer and Web UI

Properties

Class	CL_WS_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	WS_BOL_WEB_UI_API	Communication Layer between Design layer and Web UI
Created	20060705	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_WS_DESIGN_LAYER_API has no interface implemented.

Friends

Class CL_WS_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_WS_DESIGN_LAYER_API		Design Layer API	20060705

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DELETE_DESIGN	Instance method	Public	Method	Deletion of customizing	20060714
2	DELETE_DESIGN_OBJ	Instance method	Public	Method	Deletion of customizing	20060713
3	DELETE_OBJ_TYPE	Instance method	Public	Method	Deletion of customizing	20060714
4	GET_DIRECTION	Instance method	Private	Method		20080701
5	GET_FIELD_MAPPING	Instance method	Public	Method	Get field mapping	20080624
6	GET_INSTANCE	Static method	Public	Method	Creates an instance of the class	20060706
7	GET_NODE_MAPPING	Instance method	Public	Method	Get node mapping	20080630
8	LOCK	Instance method	Public	Method	Lock design	20060713
9	READ_DESIGN	Instance method	Public	Method	Read design	20060706
10	READ_DESIGN_OBJ	Instance method	Public	Method	Read design object	20060714
11	READ_OBJ_TYPE	Instance method	Public	Method	Read design object	20060707
12	READ_OBJ_TYPE_SINGLE	Instance method	Public	Method	Read design object	20070402
13	UNLOCK	Instance method	Public	Method	Unlock design	20060713
14	UPDATE_SERVICE_OBJECT_TYPE	Instance method	Public	Method	Updates a record for an existing service object.	20060726
15	WRITE_CUSTOMIZING	Instance method	Public	Method	Write design to client dependent table	20060710

Events

Class CL_WS_DESIGN_LAYER_API has no event.

Types

Class CL_WS_DESIGN_LAYER_API has no local type.

Method Signatures

Method DELETE_DESIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	BSP_ATTRIBUTES_TAB		attributes keys	20060714
2	Importing	IV_COMMIT	Call by reference	☑	Type reference (TYPE)	FLAG		General Flag	20060714
3	Importing	IV_DESIGN_OBJ	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		UI Object Type	20060714
4	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060714
5	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE		Source of design layer data: customer / SAP / both	20060714

#	Exception	Resumable	Description	Created on
1	ERROR	☐	error	20060714

Method DELETE_DESIGN_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DESIGN_OBJ	Call by reference	☐	Type reference (TYPE)	BSP_DESIGN_OBJECT_TAB		UI Object Type	20060713
2	Importing	IV_COMMIT	Call by reference	☑	Type reference (TYPE)	FLAG		General Flag	20060714
3	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060714
4	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE		Source of design layer data: customer / SAP / both	20060713

#	Exception	Resumable	Description	Created on
1	ERROR	☐	error	20060713

Method DELETE_OBJ_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE_TAB	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20060810
2	Importing	IV_COMMIT	Call by reference	☑	Type reference (TYPE)	FLAG		General Flag	20060714
3	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060714
4	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE		Source of design layer data: customer / SAP / both	20060714

#	Exception	Resumable	Description	Created on
1	ERROR	☐	error	20060714

Method GET_DIRECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASK	Call by reference	☐	Type reference (TYPE)	CRMOST_TASK		Operation	20080701
2	Returning	RV_INPUT_OUTPUT	Value transfer	☐	Type reference (TYPE)	CRMOST_STRUCTYPE		Type (Input/Output)	20080701

Method GET_DIRECTION on class CL_WS_DESIGN_LAYER_API has no exception.

Method GET_FIELD_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PROJECT_NAME	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20080624
2	Importing	IV_TASK	Call by reference	☐	Type reference (TYPE)	CRMOST_TASK		Operation	20080818
3	Returning	RT_FIELD_MAPPING	Value transfer	☐	Type reference (TYPE)	CRMOST_WS_FIELD_MAPPING_TAB		Mapping of WS fields	20080624

Method GET_FIELD_MAPPING on class CL_WS_DESIGN_LAYER_API has no exception.

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_WS_DESIGN_LAYER_API		Design Layer API	20060706

Method GET_INSTANCE on class CL_WS_DESIGN_LAYER_API has no exception.

Method GET_NODE_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PROJECT_NAME	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20080630
2	Returning	RT_NODE_MAPPING	Value transfer	☐	Type reference (TYPE)	CRMOST_WS_FIELD_MAPPING_TAB		Mapping of WS nodes	20080630

Method GET_NODE_MAPPING on class CL_WS_DESIGN_LAYER_API has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_RESULT	Call by reference	☐	Type reference (TYPE)	BAPIRET2		Return Parameter	20060717
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060713

Method LOCK on class CL_WS_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	Call by reference	☐	Type reference (TYPE)	BSP_DESIGN_TAB		Design layer: Design entries with sources	20060714
2	Importing	IV_DESIGN_OBJ	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_OBJECT		Design layer: Design object	20060714
3	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060706
4	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	20060706

Method READ_DESIGN on class CL_WS_DESIGN_LAYER_API has no exception.

Method READ_DESIGN_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DESIGN_OBJ	Call by reference	☐	Type reference (TYPE)	BSP_DESIGN_OBJ_TAB		Design layer: Object types + design objects	20060714
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLCS_OBJ_TYPE		Design layer: Object types	20060714
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	20060714

Method READ_DESIGN_OBJ on class CL_WS_DESIGN_LAYER_API has no exception.

Method READ_OBJ_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_OBJ_TYPE_TAB		system object types	20060714
2	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE		Source of design layer data: customer / SAP / both	20060714

Method READ_OBJ_TYPE on class CL_WS_DESIGN_LAYER_API has no exception.

Method READ_OBJ_TYPE_SINGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_OBJECT_TYPE		system object types	20070402
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		Source of design layer data: customer / SAP / both	20070402

Method READ_OBJ_TYPE_SINGLE on class CL_WS_DESIGN_LAYER_API has no exception.

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20060713

Method UNLOCK on class CL_WS_DESIGN_LAYER_API has no exception.

Method UPDATE_SERVICE_OBJECT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DESIGN_STRUC	Call by reference	☐	Type reference (TYPE)	BSP_OBJECT_TYPE		CRMT_RELATION_NAME	20060726
2	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	General Flag	20060728

#	Exception	Resumable	Description	Created on
1	UPDATE_FAILURE	☐		20060726

Method WRITE_CUSTOMIZING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_RESULT	Call by reference	☐	Type reference (TYPE)	BAPIRET2		Return Parameter	20060717
2	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070904
3	Importing	IS_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_OBJECT_TYPE		Object Types / Customer	20060717
4	Importing	IT_DESIGN	Call by reference	☑	Type reference (TYPE)	BSP_DESIGN_TAB		Design layer: Design entries	20060714
5	Importing	IT_DESIGN_OBJ	Call by reference	☑	Type reference (TYPE)	BSP_DESIGN_OBJ_TAB		Design layer: Design objects table	20060714
6	Importing	IV_COMMIT	Call by reference	☑	Type reference (TYPE)	FLAG	SPACE	do a COMMIT WORK AND WAIT	20060710
7	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_DESIGN_LAYER_SOURCE		Source of design layer data: customer / SAP / both	20060710

#	Exception	Resumable	Description	Created on
1	ERROR	☐	ERROR	20060710

History

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