SAP ABAP Class CL_BSP_WD_CONTEXT_API2 (Access API for context definition)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-CON (Application Component) UI Configuration & Design Layer
     ⤷ BSP_DYN_CONFIG_TOOLS (Package) Tools for Dynamic Layout

Properties

Class	CL_BSP_WD_CONTEXT_API2
Short Description	Access API for context definition
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	BSP_DYN_CONFIG_TOOLS	Tools for Dynamic Layout
Created	20060321	SAP
Last change	20081007	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_BSP_DLC_XML_STORAGE2	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_BSP_WD_CONTEXT_API2 has no interface implemented.

Friends

Class CL_BSP_WD_CONTEXT_API2 has no friend class.

Attributes

Class CL_BSP_WD_CONTEXT_API2 has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALCULATE_CONTEXT_ID	Static method	Public	Method	Liefert die Kontext ID zurück	20060409
2	GET_CONTEXT_ID	Static method	Public	Method	Liefert die Kontext ID zurück	20060321
3	LOCK_CONTEXT_ID	Static method	Public	Method	Lock context ID	20060321
4	UNLOCK_ALL_CONFIG	Static method	Public	Method	Unlock all configurations	20070814
5	UNLOCK_CONTEXT_ID	Static method	Public	Method	Unlock context ID	20060321

Events

Class CL_BSP_WD_CONTEXT_API2 has no event.

Types

Class CL_BSP_WD_CONTEXT_API2 has no local type.

Method Signatures

Method CALCULATE_CONTEXT_ID 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		Component Name	20060409
2	Importing	IV_COMPONENT_USAGE	Value transfer	☐	Type reference (TYPE)	BSP_DLC_COMPONENT_USAGE	CL_BSP_DLC_XML_STORAGE2=>DEFAULT_COMPONENT_USAGE	usage context	20060409
3	Importing	IV_OBJECT_SUB_TYPE	Value transfer	☐	Type reference (TYPE)	BSP_DLC_OBJECT_SUB_TYPE	CL_BSP_DLC_XML_STORAGE2=>DEFAULT_OBJECT_SUB_TYPE	Object Sub Type	20060409
4	Importing	IV_OBJECT_TYPE	Value transfer	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE	CL_BSP_DLC_XML_STORAGE2=>DEFAULT_OBJECT_TYPE	Object Type	20060409
5	Importing	IV_ROLE_KEY	Value transfer	☐	Type reference (TYPE)	BSP_DLC_ROLE_KEY	CL_BSP_DLC_XML_STORAGE2=>DEFAULT_ROLE_KEY	Role key	20060409
6	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	O2PAGEEXT		Name of BSP Page (Upper and Lower Case)	20060409
7	Returning	RV_CONTEXT_ID	Value transfer	☐	Type reference (TYPE)	BSP_DLC_CONTEXT_ID		Context ID	20060409

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20060409
2	PARAMETER_ERROR	☐		20060409

Method GET_CONTEXT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT	Value transfer	☐	Type reference (TYPE)	BSP_WD_COMPONENT_NAME		Component Name	20060321
2	Importing	IV_COMPONENT_USAGE	Value transfer	☑	Type reference (TYPE)	BSP_DLC_COMPONENT_USAGE		usage context	20060321
3	Importing	IV_OBJECT_SUB_TYPE	Value transfer	☑	Type reference (TYPE)	BSP_DLC_OBJECT_SUB_TYPE		Object Sub Type	20060321
4	Importing	IV_OBJECT_TYPE	Value transfer	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		Object Type	20060321
5	Importing	IV_ROLE_KEY	Value transfer	☑	Type reference (TYPE)	BSP_DLC_ROLE_KEY		Role key	20060321
6	Importing	IV_VIEWNAME	Value transfer	☐	Type reference (TYPE)	O2PAGEEXT		Name of BSP Page (Upper and Lower Case)	20060321
7	Returning	RV_CONTEXT_ID	Value transfer	☐	Type reference (TYPE)	BSP_DLC_CONTEXT_ID		Context ID	20060321

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20060409
2	PARAMETER_ERROR	☐		20060321

Method LOCK_CONTEXT_ID 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		Component Name	20060321
2	Importing	IV_COMPONENT_USAGE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_COMPONENT_USAGE		Role key	20060321
3	Importing	IV_OBJECT_SUB_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_SUB_TYPE		Object Sub Type	20060321
4	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		Component Usage	20060321
5	Importing	IV_ROLE_KEY	Call by reference	☑	Type reference (TYPE)	BSP_DLC_ROLE_KEY		Role key	20060321
6	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	O2PAGEEXT		Name of BSP Page (Upper and Lower Case)	20060321

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20060321
2	FOREIGN_LOCK	☐		20060321
3	PARAMETER_ERROR	☐		20060321

Method UNLOCK_ALL_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REC_CALL_COUNTER	Value transfer	☑	Type reference (TYPE)	I		Reccurrence call counter	20070817

Method UNLOCK_ALL_CONFIG on class CL_BSP_WD_CONTEXT_API2 has no exception.

Method UNLOCK_CONTEXT_ID 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		Component Name	20060321
2	Importing	IV_COMPONENT_USAGE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_COMPONENT_USAGE		Component Usage	20060321
3	Importing	IV_OBJECT_SUB_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_SUB_TYPE		Object Sub Type	20060321
4	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		Object Type	20060321
5	Importing	IV_ROLE_KEY	Call by reference	☑	Type reference (TYPE)	BSP_DLC_ROLE_KEY		Role key	20060321
6	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	O2PAGEEXT		Name of BSP Page (Upper and Lower Case)	20060321

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐		20060321
2	PARAMETER_ERROR	☐		20060321

History

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