SAP ABAP Class CL_CRM_UI_SESSION_RESTART (CL_CRM_UI_SESSION_RESTART)

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	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BSP_WD_FRAMEWORK_EVENTS	CRM UI Application Frame Events	20061106

Properties

Class	CL_CRM_UI_SESSION_RESTART
Short Description
Super Class
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	20060429	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_BSP_WD_FRAMEWORK_EVENTS	☐	☐	CRM UI Application Frame Events	20061106

Friends

Class CL_CRM_UI_SESSION_RESTART has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_RESTART_CAUSE_FORM_FIELD	Constant	Public	☐	Type reference (TYPE)	STRING	'restart_cause'	Name of form field 'restart_cause'	20120124
2	GC_RESTART_CAUSE_MEMORY	Constant	Public	☐	Type reference (TYPE)	STRING	'memory'	Restart due to memory consumption	20120124
3	GC_RESTART_COOKIE_NAME	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'CRM_SESSION_RESTART'	Cookie name of restart information	20060713
4	GC_RESTART_PARAMETER_NAME	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'crm-restart-id'	Name of URL Parameter for restart	20060713
5	GT_RESTART_FORMFIELDS	Static Attribute	Private	☐	Type reference (TYPE)	TIHTTPNVP		Restored form fields of last post request	20060713
6	GV_BOL_RESET_REQUESTED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Is Bol Reset requeseted	20061116
7	GV_IGNORE_NEXT_RESTART	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Flag to ignore the next restart to avoid recursive restarts	20060713
8	GV_IMMEDIATE_RESTART	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Is mandatory restart requested	20080428
9	GV_RESTART_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Is restart mechanism allowed	20060726
10	GV_RESTART_CAUSE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Reason for performing restart	20120124
11	GV_SESSION_RESTART_JSFUNCNAME	Static Attribute	Private	☐	Type reference (TYPE)	STRING		Buffer of the session restart js function	20060727
12	MEMORY_UTILS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CRM_UI_MEMORY_UTILS		Class related to memory consumption.	20060429
13	RESTART_REQUESTED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	''	Flag to denote if session restart event has been requested	20060429

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20060429
2	DISPLAY_RESTART_MESSAGE	Static method	Protected	Method	Creates an message about the restart	20060717
3	GET_MEMORY_RESTART_INFORMATION	Static method	Public	Method	Verify if current restart is caused by memory consumption	20120124
4	GET_RESTART_SCRIPT	Instance method	Public	Method	Returns the javascript script for the restart.	20060502
5	GET_SESSION_RESTART_JSFUNCNAME	Static method	Public	Method	Returns a unique name for the session restart js function	20060727
6	HANDLE_RESTART	Instance method	Public	Method	Bol Reset if restart requested and session restart if needed	20061106
7	IS_IMMEDIATE_RESTART_REQUESTED	Instance method	Public	Method	Returns if mandatory restart was requested	20080428
8	IS_SESSION_RESTART_REQUIRED	Instance method	Protected	Method		20060429
9	LOAD_RESTART_INFORMATION	Static method	Public	Method	Loads all relevant data after a restart into the request	20060713
10	ON_BETWEEN_CONTEXT_CHANGE	Instance method	Protected	Event handling method	Event handler for 'BETWEN_CONTEXT_CHANGE'	20061116
11	ON_CONTEXT_CHANGE_CANCELED	Instance method	Protected	Event handling method	Cancels the BOL reset as no context change will happen	20080204
12	ON_IMMEDIATE_RESTART	Instance method	Protected	Event handling method	Event handler for 'TRIGGER_MANDATORY_RESTART'	20080428
13	ON_SESSION_RESTART_REQUESTED	Instance method	Protected	Event handling method	Event Handler for event 'REQUEST_SESSION_RESTART'	20060501
14	QUERY_SESSION_RESTART	Instance method	Protected	Method	Returns True if session restart should be executed.	20060501
15	RESTORE_RESTART_INFORMATION	Static method	Public	Method	Restores all relevant data after a restart to be available	20060713
16	SAVE_RESTART_INFORMATION	Static method	Public	Method	Saves all data which is relevant for the restart	20060713

Events

Class CL_CRM_UI_SESSION_RESTART has no event.

Types

Class CL_CRM_UI_SESSION_RESTART has no local type.

Method Signatures

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_CRM_UI_SESSION_RESTART has no parameter.
Method CONSTRUCTOR on class CL_CRM_UI_SESSION_RESTART has no exception.

Method DISPLAY_RESTART_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Always True for Assert	20060717

Method DISPLAY_RESTART_MESSAGE on class CL_CRM_UI_SESSION_RESTART has no exception.

Method GET_MEMORY_RESTART_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RESTART_CAUSE	Call by reference	☐	Type reference (TYPE)	STRING		The cause for the current restart	20120124
2	Exporting	EV_TOKEN	Call by reference	☐	Type reference (TYPE)	BSP_WD_SECURITY_TOKEN		Corresponding token	20120124

Method GET_MEMORY_RESTART_INFORMATION on class CL_CRM_UI_SESSION_RESTART has no exception.

Method GET_RESTART_SCRIPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BSP_RUNTIME	Call by reference	☑	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20060503
2	Returning	RV_RESTART_SCRIPT	Value transfer	☐	Type reference (TYPE)	STRING			20060502

Method GET_RESTART_SCRIPT on class CL_CRM_UI_SESSION_RESTART has no exception.

Method GET_SESSION_RESTART_JSFUNCNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BSP_RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20060727
2	Returning	RV_FUNCTION_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name of the javascript function for session restart	20060727

Method GET_SESSION_RESTART_JSFUNCNAME on class CL_CRM_UI_SESSION_RESTART has no exception.

Method HANDLE_RESTART Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DO_RESTART	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Returns true if session restart should be executed	20061106

Method HANDLE_RESTART on class CL_CRM_UI_SESSION_RESTART has no exception.

Method IS_IMMEDIATE_RESTART_REQUESTED Signature

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

Method IS_IMMEDIATE_RESTART_REQUESTED on class CL_CRM_UI_SESSION_RESTART has no exception.

Method IS_SESSION_RESTART_REQUIRED Signature

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

Method IS_SESSION_RESTART_REQUIRED on class CL_CRM_UI_SESSION_RESTART has no exception.

Method LOAD_RESTART_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BSP_RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20060713

Method LOAD_RESTART_INFORMATION on class CL_CRM_UI_SESSION_RESTART has no exception.

Method ON_BETWEEN_CONTEXT_CHANGE Signature

Method ON_BETWEEN_CONTEXT_CHANGE on class CL_CRM_UI_SESSION_RESTART has no parameter.
Method ON_BETWEEN_CONTEXT_CHANGE on class CL_CRM_UI_SESSION_RESTART has no exception.

Method ON_CONTEXT_CHANGE_CANCELED Signature

Method ON_CONTEXT_CHANGE_CANCELED on class CL_CRM_UI_SESSION_RESTART has no parameter.
Method ON_CONTEXT_CHANGE_CANCELED on class CL_CRM_UI_SESSION_RESTART has no exception.

Method ON_IMMEDIATE_RESTART Signature

Method ON_IMMEDIATE_RESTART on class CL_CRM_UI_SESSION_RESTART has no parameter.
Method ON_IMMEDIATE_RESTART on class CL_CRM_UI_SESSION_RESTART has no exception.

Method ON_SESSION_RESTART_REQUESTED Signature

Method ON_SESSION_RESTART_REQUESTED on class CL_CRM_UI_SESSION_RESTART has no parameter.
Method ON_SESSION_RESTART_REQUESTED on class CL_CRM_UI_SESSION_RESTART has no exception.

Method QUERY_SESSION_RESTART Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DO_CHECK	Value transfer	☑	Type reference (TYPE)	ABAP_BOOL	''	Indicate if session restart should be checked	20060501
2	Returning	RV_DO_RESTART	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Returns true if session restart should be executed	20060502

Method QUERY_SESSION_RESTART on class CL_CRM_UI_SESSION_RESTART has no exception.

Method RESTORE_RESTART_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RESTART_ID	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		ID of the cookie that has the restart data	20060713

Method RESTORE_RESTART_INFORMATION on class CL_CRM_UI_SESSION_RESTART has no exception.

Method SAVE_RESTART_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BSP_RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20060713

Method SAVE_RESTART_INFORMATION on class CL_CRM_UI_SESSION_RESTART has no exception.

History

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