SAP ABAP Class CL_CRM_BSP_STATE (State class.)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-GTF-PCF (Application Component) People Centric UI Framework
     ⤷ CRM_BSP_FRAME_GENERIC (Package) Controller Implementation: Generic Framework

Properties

Class	CL_CRM_BSP_STATE
Short Description	State class.
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_BSP_FRAME_GENERIC	Controller Implementation: Generic Framework
Created	20041021	SAP
Last change	20050615	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_CRM_BSP_STATE has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CRM_BSP_STATE_MANAGER	☐	20041116	State manager class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GR_ROOT_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_CRM_BSP_CONTAINER		Generic data container.	20041116
2	GV_APPLICATION	Instance attribute	Private	☐	Type reference (TYPE)	CRMT_BSP_APPL			20041116
3	GV_BLVIEW	Instance attribute	Private	☐	Type reference (TYPE)	CRMT_BSP_BLVIEW			20041116
4	GV_BROWSER_WINDOW_ID	Instance attribute	Private	☐	Type reference (TYPE)	CRMT_BSP_BROWSER_WINDOW_ID		Unique ID of a web browser window.	20041116
5	GV_CHANGED_ON	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20041116
6	GV_CREATED_ON	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20041116
7	GV_CURRENT_COMPONENT_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Current component ID.	20041223
8	GV_DIRTY	Instance attribute	Private	☐	Type reference (TYPE)	FLAG	' '	General flag	20041119
9	GV_IS_FIRST_REQUEST	Instance attribute	Private	☐	Type reference (TYPE)	FLAG	'X'	General flag	20041116
10	GV_OBJECT_ID	Instance attribute	Private	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY		Object Key	20041116
11	GV_PREVIEW_MODE_ATTR_NAME	Constant	Private	☐	Type reference (TYPE)	CRMT_BSP_CONTAINER_ATTR_NAME	'SAP_CL_CRM_BSP_STATE_PREVIEW_M'	Preview mode flag	20041206
12	GV_PREVIEW_MODE_URL_PARAM	Constant	Private	☐	Type reference (TYPE)	CHAR20	'PREVIEW_MODE'	Preview mode URL param	20041206
13	GV_ROOT_CONTAINER_NAME	Constant	Private	☐	Type reference (TYPE)	CRMT_BSP_CONTAINER_NAME	'SAP_CL_CRM_BSP_STATE_ROOT'	Name of a generic attribute container.	20041116
14	GV_UNSPECIFIED_OBJECT_ID	Constant	Public	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY	'UNSPECIFIED'	Object Key	20041116
15	GV_UNSPECIFIED_WINDOW_ID	Constant	Public	☐	Type reference (TYPE)	CRMT_BSP_BROWSER_WINDOW_ID	'UNSPECIFIED'	Unique ID of a web browser window.	20041116
16	GV_URL_PARAM_CONTAINER_NAME	Constant	Private	☐	Type reference (TYPE)	CRMT_BSP_CONTAINER_NAME	'SAP_CL_CRM_BSP_STATE_URL_PARAM'	Name of a generic attribute container.	20041116
17	GV_URL_PARAM_WINDOW_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'sap-clntwndid'	Name of window ID URL parameter name.	20050113
18	GV_USER_ID	Instance attribute	Private	☐	Type reference (TYPE)	SYUNAME		SAP System, User Logon Name	20041116
19	GV_VERSION_ATTR_NAME	Constant	Private	☐	Type reference (TYPE)	CRMT_BSP_CONTAINER_ATTR_NAME	'SAP_CL_CRM_BSP_STATE_VERSION'	Name of a generic container attribute.	20050609
20	GV_VIEW_TYPE_ATTR_NAME	Constant	Private	☐	Type reference (TYPE)	CRMT_BSP_CONTAINER_ATTR_NAME	'SAP_CL_CRM_BSP_STATE_VIEW_TYPE'	Name of a generic container attribute.	20041116

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAR_FIRST_REQUEST_FLAG	Instance method	Public	Method	Clears the first request flag.	20041116
2	CLEAR_PREVIEW_MODE_FLAG	Instance method	Public	Method	Clears the preview mode flag.	20041206
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20041116
4	GET_APPLICATION	Instance method	Public	Method	Returns this state's application.	20041116
5	GET_BLVIEW	Instance method	Public	Method	Returns this state's blueprint view.	20041116
6	GET_BROWSER_WINDOW_ID	Instance method	Public	Method	Returns this state's browser window ID, if any.	20041116
7	GET_CHANGED_ON	Instance method	Public	Method	Returns this state's last change date.	20041116
8	GET_CREATED_ON	Instance method	Public	Method	Returns this state's creation date.	20041116
9	GET_CURRENT_COMPONENT_ID	Instance method	Public	Method	Returns this state's current screen position.	20041223
10	GET_OBJECT_ID	Instance method	Public	Method	Returns this state's object key, if any.	20041116
11	GET_STATE_CONTAINER	Instance method	Public	Method	Returns the container with the specified name.	20041116
12	GET_URL_PARAMETER	Instance method	Public	Method	Returns the specified URL parameter.	20041116
13	GET_URL_PARAMETERS	Instance method	Public	Method	Returns all the URL parameters.	20041209
14	GET_USER_ID	Instance method	Public	Method	Returns this state's user name.	20041116
15	GET_VIEW_TYPE	Instance method	Public	Method	Returns the current view type (OIP or ODP).	20041116
16	IS_FIRST_REQUEST	Instance method	Public	Method	Returns 'X' if this is the first request in the session.	20041116
17	IS_PREVIEW_MODE	Instance method	Public	Method	Returns the preview mode flag.	20041206
18	RELEASE	Instance method	Public	Method	Releases the memory occupied by the state.	20041119
19	REMOVE_STATE_CONTAINER	Instance method	Public	Method	Removes the specified state container.	20041119
20	SAVE	Instance method	Public	Method	Saves the state to a data store.	20041116
21	SET_CURRENT_COMPONENT_ID	Instance method	Public	Method	Sets this state's current screen position.	20041223
22	SET_PREVIEW_MODE_FLAG	Instance method	Public	Method	Sets the preview mode flag.	20041206
23	SET_URL_PARAMETERS	Instance method	Public	Method	Stores the specified URL parameters.	20041116
24	SET_VIEW_TYPE	Instance method	Public	Method	Sets the current view type (OIP or ODP).	20041116

Events

Class CL_CRM_BSP_STATE has no event.

Types

Class CL_CRM_BSP_STATE has no local type.

Method Signatures

Method CLEAR_FIRST_REQUEST_FLAG Signature

Method CLEAR_FIRST_REQUEST_FLAG on class CL_CRM_BSP_STATE has no parameter.
Method CLEAR_FIRST_REQUEST_FLAG on class CL_CRM_BSP_STATE has no exception.

Method CLEAR_PREVIEW_MODE_FLAG Signature

Method CLEAR_PREVIEW_MODE_FLAG on class CL_CRM_BSP_STATE has no parameter.
Method CLEAR_PREVIEW_MODE_FLAG on class CL_CRM_BSP_STATE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_APPL			20041116
2	Importing	IV_BLVIEW	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_BLVIEW			20041116
3	Importing	IV_BROWSER_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_BROWSER_WINDOW_ID		Eindeutige ID eines Web-Browser-Fensters	20041116
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY		Objektschlüssel	20041116
5	Importing	IV_USER_ID	Call by reference	☐	Type reference (TYPE)	SYUNAME		SAP-System, Anmeldename des Benutzers	20041116
6	Importing	IV_VERSION	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_VERSION		Version of BSP Application	20050609

Method CONSTRUCTOR on class CL_CRM_BSP_STATE has no exception.

Method GET_APPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_APPLICATION	Value transfer	☐	Type reference (TYPE)	CRMT_BSP_APPL			20041116

Method GET_APPLICATION on class CL_CRM_BSP_STATE has no exception.

Method GET_BLVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_BLVIEW	Value transfer	☐	Type reference (TYPE)	CRMT_BSP_BLVIEW			20041116

Method GET_BLVIEW on class CL_CRM_BSP_STATE has no exception.

Method GET_BROWSER_WINDOW_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_BROWSER_WINDOW_ID	Value transfer	☐	Type reference (TYPE)	CRMT_BSP_BROWSER_WINDOW_ID		Eindeutige ID eines Web-Browser-Fensters	20041116

Method GET_BROWSER_WINDOW_ID on class CL_CRM_BSP_STATE has no exception.

Method GET_CHANGED_ON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CHANGED_ON	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC-Zeitstempel in Kurzform (JJJJMMTTssmmss)	20041116

Method GET_CHANGED_ON on class CL_CRM_BSP_STATE has no exception.

Method GET_CREATED_ON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CREATED_ON	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC-Zeitstempel in Kurzform (JJJJMMTTssmmss)	20041116

Method GET_CREATED_ON on class CL_CRM_BSP_STATE has no exception.

Method GET_CURRENT_COMPONENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CURRENT_COMPONENT_ID	Value transfer	☐	Type reference (TYPE)	STRING		Bildposition in Feldgruppentabelle	20041223

Method GET_CURRENT_COMPONENT_ID on class CL_CRM_BSP_STATE has no exception.

Method GET_OBJECT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY		Objektschlüssel	20041116

Method GET_OBJECT_ID on class CL_CRM_BSP_STATE has no exception.

Method GET_STATE_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Bildposition in Feldgruppentabelle	20041223
2	Importing	IV_CONTAINER_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_CONTAINER_NAME		Name eines allgemeinen Attributcontainers	20041116
3	Returning	RR_CONTAINER	Value transfer	☐	Object reference (TYPE REF TO)	IF_CRM_BSP_CONTAINER		Generic data container.	20041116

Method GET_STATE_CONTAINER on class CL_CRM_BSP_STATE has no exception.

Method GET_URL_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_URL_PARAM_NAME		URL-Parametername	20041116
2	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	CRMT_BSP_URL_PARAM_VALUE		URL-Parameterwert	20041116

Method GET_URL_PARAMETER on class CL_CRM_BSP_STATE has no exception.

Method GET_URL_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_URL_PARAMETERS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Tabelle Name-Wert-Paare	20041209

Method GET_URL_PARAMETERS on class CL_CRM_BSP_STATE has no exception.

Method GET_USER_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_USER_ID	Value transfer	☐	Type reference (TYPE)	SYUNAME		SAP-System, Anmeldename des Benutzers	20041116

Method GET_USER_ID on class CL_CRM_BSP_STATE has no exception.

Method GET_VIEW_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VIEW_TYPE	Value transfer	☐	Type reference (TYPE)	CRMT_BSP_CURRENT_VIEW_TYPE		Current PCUI view type (OIP or ODP).	20041116

Method GET_VIEW_TYPE on class CL_CRM_BSP_STATE has no exception.

Method IS_FIRST_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_FIRST_REQUEST	Value transfer	☐	Type reference (TYPE)	FLAG		Allgemeines Kennzeichen	20041116

Method IS_FIRST_REQUEST on class CL_CRM_BSP_STATE has no exception.

Method IS_PREVIEW_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_PREVIEW_MODE	Value transfer	☐	Type reference (TYPE)	FLAG		Allgemeines Kennzeichen	20041206

Method IS_PREVIEW_MODE on class CL_CRM_BSP_STATE has no exception.

Method RELEASE Signature

Method RELEASE on class CL_CRM_BSP_STATE has no parameter.
Method RELEASE on class CL_CRM_BSP_STATE has no exception.

Method REMOVE_STATE_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT_ID	Call by reference	☑	Type reference (TYPE)	CRMT_BSP_SCREENPOSITION		Bildposition in Feldgruppentabelle	20041223
2	Importing	IV_CONTAINER_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_CONTAINER_NAME		Name eines allgemeinen Attributcontainers	20041119

Method REMOVE_STATE_CONTAINER on class CL_CRM_BSP_STATE has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BACKGROUND	Call by reference	☑	Type reference (TYPE)	FLAG		Allgemeines Kennzeichen	20041116

Method SAVE on class CL_CRM_BSP_STATE has no exception.

Method SET_CURRENT_COMPONENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENT_COMPONENT_ID	Call by reference	☐	Type reference (TYPE)	STRING		Bildposition in Feldgruppentabelle	20041223

Method SET_CURRENT_COMPONENT_ID on class CL_CRM_BSP_STATE has no exception.

Method SET_PREVIEW_MODE_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PREVIEW_MODE	Call by reference	☐	Type reference (TYPE)	FLAG		Allgemeines Kennzeichen	20041206

Method SET_PREVIEW_MODE_FLAG on class CL_CRM_BSP_STATE has no exception.

Method SET_URL_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_URL_PARAMETERS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		Tabelle der URL-Parameternamen und -werte	20041116

Method SET_URL_PARAMETERS on class CL_CRM_BSP_STATE has no exception.

Method SET_VIEW_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VIEW_TYPE	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_CURRENT_VIEW_TYPE		Current PCUI view type (OIP or ODP).	20041116

Method SET_VIEW_TYPE on class CL_CRM_BSP_STATE has no exception.

History

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