SAP ABAP Class CL_CRM_UI_FRAME (Application Base Class)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-APF (Application Component) Application Frame
     ⤷ CRM_BSP_UI_FRAME_CORE (Package) Application Frame DDIC, Services and Utilities

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BSP_WD_APPLICATION	BSP WD Application	20060214
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CRM_WEB_CALLBACK	Interface for handler method of service callback	20080225

Properties

Class	CL_CRM_UI_FRAME
Short Description	Application Base Class
Super Class	CL_BSP_WD_APPLICATION	BSP WD Application
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_BSP_UI_FRAME_CORE	Application Frame DDIC, Services and Utilities
Created	20060214	SAP
Last change	20130531	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

#	Interface	Abstract	Final	Description	Created on
1	IF_CRM_WEB_CALLBACK	☐	☐	Interface for handler method of service callback	20080225

Friends

Class CL_CRM_UI_FRAME has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ALWAYS_LOGOFF	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Always logoff on session end	20080410
2	GV_EP_BASE_URL	Instance attribute	Public	☐	Type reference (TYPE)	STRING		Base URL of Enterprise Portal (empty if not in portal)	20070913
3	GV_EXISTING_SESSION	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicates that Default.htm was loaded in an existing session	20071210
4	GV_FIRST_TIME	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	First Request Flag	20060907
5	GV_RESTART_CAUSE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Cause for a session restart (e.g. memory consumption)	20120124
6	GV_RF_PROFILE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BSP_WD_RF_PROFILE		Runtime Framework Profile	20060316
7	GV_TOKEN	Instance attribute	Private	☐	Type reference (TYPE)	BSP_WD_SECURITY_TOKEN		Token before restart.	20120124
8	IMMEDIATE_SESSION_END	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Immediate Session End	20080318
9	MAX_IDLE_TIME	Instance attribute	Protected	☐	Type reference (TYPE)	TIMS		Maximum Idle time for this session	20080318
10	SHUTDOWN_TIME	Instance attribute	Protected	☐	Type reference (TYPE)	TIMS	'000010'	Time to shutdown the session	20080318

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	EH_REQUEST_RESET	Instance method	Protected	Event handling method		20060630
2	GET_MEMORY_RESTART_TOKEN	Instance method	Public	Method	Get token for memory consumption restart	20120124
3	ON_TIMEOUT	Instance method	Public	Event handling method	Session Timeout Handler	20060711
4	SET_DH_AUTO_MODE_IF_POSSIBLE	Instance method	Protected	Method	Set Delta Handling mode to AUTO (if possible)	20080605
5	SET_RESTART_INFORMATION	Instance method	Public	Method	Set information about session restart	20120124
6	TRY_RESET	Instance method	Public	Method	Reacts on 'usr_abort' DSM requests from Portal	20070531
7	TRY_SUSPEND	Instance method	Public	Method	Reacts on 'usr_suspend' DSM requests from Portal	20070815
8	WRITETOPAGECONTEXT	Static method	Public	Method	Writes the given string into the current page context	20070418

Events

Class CL_CRM_UI_FRAME has no event.

Types

Class CL_CRM_UI_FRAME has no local type.

Method Signatures

Method EH_REQUEST_RESET Signature

Method EH_REQUEST_RESET on class CL_CRM_UI_FRAME has no parameter.
Method EH_REQUEST_RESET on class CL_CRM_UI_FRAME has no exception.

Method GET_MEMORY_RESTART_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TOKEN	Value transfer	☐	Type reference (TYPE)	BSP_WD_SECURITY_TOKEN		128Bit security token	20120124

Method GET_MEMORY_RESTART_TOKEN on class CL_CRM_UI_FRAME has no exception.

Method ON_TIMEOUT Signature

Method ON_TIMEOUT on class CL_CRM_UI_FRAME has no parameter.
Method ON_TIMEOUT on class CL_CRM_UI_FRAME has no exception.

Method SET_DH_AUTO_MODE_IF_POSSIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SUCCESS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080605

Method SET_DH_AUTO_MODE_IF_POSSIBLE on class CL_CRM_UI_FRAME has no exception.

Method SET_RESTART_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RESTART_CAUSE	Call by reference	☐	Type reference (TYPE)	STRING			20120124
2	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	BSP_WD_SECURITY_TOKEN		128Bit security token	20120124

Method SET_RESTART_INFORMATION on class CL_CRM_UI_FRAME has no exception.

Method TRY_RESET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	APPLICATION_STATE	Value transfer	☐	Type reference (TYPE)	I			20070531

Method TRY_RESET on class CL_CRM_UI_FRAME has no exception.

Method TRY_SUSPEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	APPLICATION_STATE	Value transfer	☐	Type reference (TYPE)	I			20070815

Method TRY_SUSPEND on class CL_CRM_UI_FRAME has no exception.

Method WRITETOPAGECONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PAGE_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_PAGE_CONTEXT		Page Context	20070418
2	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Text that should be rendered	20070418
3	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Always True	20070418

Method WRITETOPAGECONTEXT on class CL_CRM_UI_FRAME has no exception.

History

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