SAP ABAP Class CL_BSP_WD_HIST_MANAGER_BASE (History Manager Base Class)

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BSP_WD_HISTORY_MANAGER	History Manager Interface	20051012
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BSP_WD_HISTORY_MANAGER_DISP	Display interface of WD history manager	20051012

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BSP_WD_HISTORY_MANAGER	IC History Manager	20051012
2	Inheritance (c INHERITING FROM c_ref)	CL_BSP_WD_HISTORY_STACK	Stack-Oriented History Manager	20051012

Properties

Class	CL_BSP_WD_HIST_MANAGER_BASE
Short Description	History Manager Base Class
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	20051012	SAP
Last change	20110908	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)
2	CL_BSP_WD_RF_PROFILE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BSP_WD_HISTORY_MANAGER	☐	☐	History Manager Interface	20051012
2	IF_BSP_WD_HISTORY_MANAGER_DISP	☐	☐	Display interface of WD history manager	20051012

Friends

Class CL_BSP_WD_HIST_MANAGER_BASE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CANCELING_RESTORE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20081211
2	CO_MODE_NORMAL	Constant	Protected	☐	Type reference (TYPE)	CHAR1	'N'	Normal Operation Mode	20051012
3	CO_MODE_RESTORE	Constant	Protected	☐	Type reference (TYPE)	CHAR1	'R'	Restore Operation Mode	20051012
4	CURRENT_STATE_LINE	Instance attribute	Protected	☐	Type reference (TYPE)	HISTORY_LINE			20051012
5	ENTRY_ID	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Natural Number	20070202
6	HISTORY	Instance attribute	Protected	☐	Type reference (TYPE)	HISTORY_TAB		History	20051012
7	LOGGING_ACTIVE	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20051012
8	MAX_HIST_ENTRIES	Instance attribute	Protected	☐	Type reference (TYPE)	I	0	Maximum Number of History Entries	20060908
9	MODE	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1	CO_MODE_NORMAL	Operation Mode	20051012
10	NAVIGATION_ACTIVE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20051012
11	NO_DUPLICATE_ENTRIES	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicator: History Recording Without Duplicated Entries	20101118
12	RESTORE_STACK	Instance attribute	Protected	☐	Type reference (TYPE)	LTY_STATE_ID_TAB		Table of Uninterrupted Restores	20081124
13	SAVED_TABIX	Instance attribute	Protected	☐	Type reference (TYPE)	SYTABIX		Index of Internal Tables	20051111
14	STATE_COUNT	Instance attribute	Protected	☐	Type reference (TYPE)	I	0	State ID Counter	20051012
15	STATE_TO_RESTORE	Instance attribute	Public	☑	Type reference (TYPE)	SYTABIX		Index of State to Be Recovered	20060420
16	VIEW_MANAGER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_MANAGER		View Manager - Web Dynpro	20051012

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CANCEL_RESTORE	Instance method	Public	Method	Reset State to Be Recovered	20060522
2	CHECK_RESTORE_CHANGES_LEAD_ENT	Instance method	Public	Method	Checks Whether Waiting Recovery Changes the Leading Entity	20060721
3	CHECK_RESTORE_CHANGES_TX_CTXT	Instance method	Public	Method	Checks Whether Waiting Recovery Changes the Leading Entity	20070502
4	CHECK_RESTORE_CHANGES_WA	Instance method	Public	Method	Checks Whether Waiting Recovery Changes the Work Area	20060420
5	CHECK_VIEW_ASSEMBLIES_EQUAL	Instance method	Protected	Method		20051012
6	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20051012
7	DO_BEFORE_ADDING_HIST_LINE	Instance method	Protected	Method		20051012
8	DO_ON_CHANGED_HISTORIC_STATE	Instance method	Protected	Method		20081124
9	DO_ON_LEAVING_RESTORE_MODE	Instance method	Protected	Method		20051012
10	GET_CURRENT_STATE_ID	Instance method	Public	Method		20090731
11	GET_REP_VIEW	Instance method	Protected	Method		20060419
12	GET_STATE	Instance method	Protected	Method		20051012
13	GET_STATE_ID_FROM_IDX	Instance method	Public	Method		20080528
14	GET_VIEW_ASSEMBLY	Instance method	Protected	Method	Store Current State as History Entry	20051012
15	ON_BOL_RESET_FINISHED	Instance method	Protected	Event handling method		20070130
16	ON_BOL_RESET_TRIGGERED	Instance method	Protected	Event handling method		20070130
17	ON_END_OF_NAVIGATION	Instance method	Protected	Event handling method		20051012
18	ON_ENTITY_DELETED	Instance method	Protected	Event handling method		20051012
19	ON_HISTORY_TRIGGER	Instance method	Public	Event handling method	Event Handler for History Query	20051012
20	ON_NAVIGATION_STEP	Instance method	Protected	Event handling method		20061107
21	ON_START_OF_NAVIGATION	Instance method	Protected	Event handling method		20051012
22	RESTORE_STATE	Instance method	Public	Method		20051012
23	RESTORE_VIEW_STATE	Instance method	Protected	Method	Restore Current State as History Entry	20051012
24	SET_ACTIVE	Instance method	Public	Method		20051012
25	SET_INACTIVE	Instance method	Public	Method		20051012
26	STORE_VIEW_STATE	Instance method	Protected	Method	Store Current State as History Entry	20051012
27	WRITE_EXCEPTION	Instance method	Private	Method		20081211

Events

#	Event	Type	Visibility	Description	Created on
1	RESET	Static Event (1)	Public (2)		20051012
2	STATE_CREATED	Instance Event (0)	Protected (1)		20051013
3	STATE_DELETED	Instance Event (0)	Protected (1)		20070809
4	STATE_RESTORED	Instance Event (0)	Protected (1)		20051013

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	HISTORY_LINE	Protected	See coding			20051012	begin of HISTORY_LINE, STATE_ID type I, STATE_TEXT type STRING, LEADING_ENTITY type ref to CL_CRM_BOL_ENTITY, VIEW_NAME type STRING, RENDERING_GROUP type STRING, START_REP_VIEW type ref to CL_BSP_WD_REP_VIEW, VIEW_STATES type VIEW_STATE_TAB, end of HISTORY_LINE
2	HISTORY_TAB	Protected	See coding			20051012	HISTORY_TAB type standard table of HISTORY_LINE
3	LTY_STATE_ID_TAB	Protected	See coding			20081124	LTY_STATE_ID_TAB type standard table of i
4	VIEW_STATE	Protected	See coding			20051012	begin of VIEW_STATE, ENTRY_ID type INT4, PARENT_ENTRY_ID type INT4, REP_VIEW type ref to CL_BSP_WD_REP_VIEW, CONTEXT_STATE type ref to CL_BSP_WD_HISTORY_STATE_CONT, AREA_CONT type TBSP_WD_REP_VIEWAREA_ASSIGNS, end of VIEW_STATE
5	VIEW_STATE_TAB	Protected	See coding			20051012	VIEW_STATE_TAB type hashed table of VIEW_STATE with unique key PARENT_ENTRY_ID REP_VIEW initial size 20

Method Signatures

Method CANCEL_RESTORE Signature

Method CANCEL_RESTORE on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Method CANCEL_RESTORE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method CHECK_RESTORE_CHANGES_LEAD_ENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATE_INDEX	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index des zu prüfenden Zustandes	20060721
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060721

Method CHECK_RESTORE_CHANGES_LEAD_ENT on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method CHECK_RESTORE_CHANGES_TX_CTXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATE_INDEX	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index des zu prüfenden Zustandes	20070502
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070502

Method CHECK_RESTORE_CHANGES_TX_CTXT on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method CHECK_RESTORE_CHANGES_WA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATE_INDEX	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index des zu prüfenden Zustandes	20060420
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060420

Method CHECK_RESTORE_CHANGES_WA on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method CHECK_VIEW_ASSEMBLIES_EQUAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_VIEW_STATE_1	Call by reference	☐	Type reference (TYPE)	VIEW_STATE_TAB			20051012
2	Importing	IT_VIEW_STATE_2	Call by reference	☐	Type reference (TYPE)	VIEW_STATE_TAB			20051012
3	Returning	RV_EQUAL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20051012

Method CHECK_VIEW_ASSEMBLIES_EQUAL on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MAX_HIST_ENTRIES	Call by reference	☐	Type reference (TYPE)	INT4	0	Maximale Anzahl von aufgezeichn. Schritten in der Historie	20060908
2	Importing	VIEW_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_MANAGER		View-Manager - Wen Dynpro	20051012

Method CONSTRUCTOR on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method DO_BEFORE_ADDING_HIST_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_NEW_HIST_LINE	Call by reference	☑	Type reference (TYPE)	HISTORY_LINE			20051012
2	Changing	CV_SAVE_STATE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20051115
3	Importing	IV_CURRENT_STATE_ID	Call by reference	☐	Type reference (TYPE)	I			20090731
4	Importing	IV_RESTORABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20051115

Method DO_BEFORE_ADDING_HIST_LINE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method DO_ON_CHANGED_HISTORIC_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENT_STATE	Value transfer	☐	Type reference (TYPE)	I		ID des aktuelle Zustands	20081124
2	Returning	RV_STORE_STATE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081124

Method DO_ON_CHANGED_HISTORIC_STATE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method DO_ON_LEAVING_RESTORE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENT_STATE	Value transfer	☐	Type reference (TYPE)	I		ID des aktuelle Zustands	20081124

Method DO_ON_LEAVING_RESTORE_MODE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method GET_CURRENT_STATE_ID Signature

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

Method GET_CURRENT_STATE_ID on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method GET_REP_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONSIDER_OUTER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20080724
2	Importing	IV_VIEW_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER		Basisklasse für WD View Controller	20060419
3	Returning	RV_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_BSP_WD_REP_VIEW		Web Dynpro Sicht Repository-Objekt	20060419

Method GET_REP_VIEW on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_STATE	Call by reference	☐	Type reference (TYPE)	HISTORY_LINE			20051012
2	Exporting	EV_TABIX	Call by reference	☐	Type reference (TYPE)	SYTABIX			20051012
3	Importing	IV_VIEW_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER			20051012

Method GET_STATE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method GET_STATE_ID_FROM_IDX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATE_INDEX	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index interner Tabellen	20080528
2	Returning	RV_STATE_ID	Value transfer	☐	Type reference (TYPE)	I			20080528

Method GET_STATE_ID_FROM_IDX on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method GET_VIEW_ASSEMBLY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARENT_ENTRY_ID	Call by reference	☐	Type reference (TYPE)	INT4		ID des Vater Eintrages in der View-State Tabelle	20070202
2	Importing	VIEW	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER		Basisklasse für WD-View-Cotroller	20051012
3	Changing	VIEW_STATES	Call by reference	☐	Type reference (TYPE)	VIEW_STATE_TAB		Table of view states	20051012

Method GET_VIEW_ASSEMBLY on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method ON_BOL_RESET_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Value transfer	☐	Attribute reference (LIKE)				20070130

Method ON_BOL_RESET_FINISHED on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method ON_BOL_RESET_TRIGGERED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXCEPTIONS	Call by reference	☐	Attribute reference (LIKE)				20090216

Method ON_BOL_RESET_TRIGGERED on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method ON_END_OF_NAVIGATION Signature

Method ON_END_OF_NAVIGATION on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Method ON_END_OF_NAVIGATION on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method ON_ENTITY_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Value transfer	☐	Attribute reference (LIKE)				20051012

Method ON_ENTITY_DELETED on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method ON_HISTORY_TRIGGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20051012

Method ON_HISTORY_TRIGGER on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method ON_NAVIGATION_STEP Signature

Method ON_NAVIGATION_STEP on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Method ON_NAVIGATION_STEP on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method ON_START_OF_NAVIGATION Signature

Method ON_START_OF_NAVIGATION on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Method ON_START_OF_NAVIGATION on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method RESTORE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TABIX	Call by reference	☐	Type reference (TYPE)	I			20051012

Method RESTORE_STATE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method RESTORE_VIEW_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATE_ID	Call by reference	☐	Type reference (TYPE)	I		Status-ID	20051012
2	Importing	VIEWAREA	Call by reference	☐	Type reference (TYPE)	STRING		View area	20051012
3	Importing	VIEWAREA_OWNER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER		Basisklasse für WD-View-Cotroller	20051012
4	Importing	VIEW_STATE	Call by reference	☐	Type reference (TYPE)	VIEW_STATE		View state to restore	20051012
5	Importing	VIEW_STATES	Call by reference	☐	Type reference (TYPE)	VIEW_STATE_TAB		Table of view states	20051012

Method RESTORE_VIEW_STATE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method SET_ACTIVE Signature

Method SET_ACTIVE on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Method SET_ACTIVE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method SET_INACTIVE Signature

Method SET_INACTIVE on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Method SET_INACTIVE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method STORE_VIEW_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARENT_ENTRY_ID	Call by reference	☐	Type reference (TYPE)	INT4		ID des Vater Eintrages in der View-State Tabelle	20070202
2	Importing	STATE_ID	Call by reference	☐	Type reference (TYPE)	I		Status-ID	20051012
3	Importing	VIEW	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER		Basisklasse für WD-View-Cotroller	20051012
4	Changing	VIEW_STATES	Call by reference	☐	Type reference (TYPE)	VIEW_STATE_TAB		Table of view states	20051012

Method STORE_VIEW_STATE on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Method WRITE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT	Call by reference	☑	Type reference (TYPE)	STRING		Kontext Information	20081211
2	Importing	IV_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstrakte Oberklasse aller globalen Exceptions	20081211

Method WRITE_EXCEPTION on class CL_BSP_WD_HIST_MANAGER_BASE has no exception.

Event Signatures

Event RESET Signature
Event RESET on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Event STATE_CREATED Signature
Event STATE_CREATED on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Event STATE_DELETED Signature
Event STATE_DELETED on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.
Event STATE_RESTORED Signature
Event STATE_RESTORED on class CL_BSP_WD_HIST_MANAGER_BASE has no parameter.

History

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