SAP ABAP Class CL_BSP_WD_REFERENCE_TOOL (Store references to Objects)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-UI-RT (Application Component) UI Runtime Environment
     ⤷ CRM_BSP_WD (Package) WebClient UI Framework Runtime

Properties

Class	CL_BSP_WD_REFERENCE_TOOL
Short Description	Store references to Objects
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_BSP_WD	WebClient UI Framework Runtime
Created	20060407	SAP
Last change	20100303	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)

Interfaces

Class CL_BSP_WD_REFERENCE_TOOL has no interface implemented.

Friends

Class CL_BSP_WD_REFERENCE_TOOL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GT_REF_TAB	Static Attribute	Protected	☐	Type reference (TYPE)	GTYPE_REF_CONTAINER_TAB		Lookup table of references	20060407
2	GV_KEY_PREFIX	Static Attribute	Private	☐	Type reference (TYPE)	STRING	'LK'		20060509

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAR_REFERENCES	Static method	Public	Method	Clear all the references int he cache	20060407
2	GENERATE_KEY	Static method	Public	Method	Generate a unique key to by used to save a reference	20060509
3	GET_REFERENCE	Static method	Public	Method	Retrieve a reference in the cache	20060407
4	REMOVE_REFERENCE	Static method	Public	Method	Remove a reference cache	20060407
5	SET_REFERENCE	Static method	Public	Method	Set a reference to the cache	20060407

Events

Class CL_BSP_WD_REFERENCE_TOOL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTYPE_REF_CONTAINER	Protected	See coding			20060407	BEGIN OF gtype_ref_container, key_name TYPE string, cc_ref TYPE REF TO object, END OF gtype_ref_container
2	GTYPE_REF_CONTAINER_TAB	Protected	See coding			20060407	gtype_ref_container_tab TYPE STANDARD TABLE OF gtype_ref_container WITH KEY key_name

Method Signatures

Method CLEAR_REFERENCES Signature

Method CLEAR_REFERENCES on class CL_BSP_WD_REFERENCE_TOOL has no parameter.
Method CLEAR_REFERENCES on class CL_BSP_WD_REFERENCE_TOOL has no exception.

Method GENERATE_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20060509

Method GENERATE_KEY on class CL_BSP_WD_REFERENCE_TOOL has no exception.

Method GET_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTROLLER_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20060407
2	Returning	RR_CONTROLLER_REF	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT			20060407

Method GET_REFERENCE on class CL_BSP_WD_REFERENCE_TOOL has no exception.

Method REMOVE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REF_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20060407

Method REMOVE_REFERENCE on class CL_BSP_WD_REFERENCE_TOOL has no exception.

Method SET_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTROLLER_KEY	Call by reference	☐	Type reference (TYPE)	STRING		The lookup key to retrieve the stored reference	20060407
2	Importing	IV_CONTROLLER_REF	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		The reference to store	20060407
3	Importing	IV_REMOVE_EXISTING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	''	Remove older references before adding new reference	20060418

Method SET_REFERENCE on class CL_BSP_WD_REFERENCE_TOOL has no exception.

History

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