SAP ABAP Class CL_BSP_WD_GEN_ROADMAP_VS (Generic ViewSet for configurable roadmaps)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-UI-RT (Application Component) UI Runtime Environment
     ⤷ BSP_DYN_LAYOUT_TB_UI_RUNTIME (Package) Guided Activity Page runtime objects

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BSP_WD_DYN_VIEWSET	Dynamic Viewset base class	20080221
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BSP_DLC_PROCESS_CONTROL	Roadmap Control Interface	20080429
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BSP_DLC_PROCESS_STEP	Roadmap Step Interface	20090126
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BSP_WD_DYN_BTN_CONTROL	Dynamic Button control Interface	20080429

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_AXT_EEW__MIGRATIONTB		20090810
2	Inheritance (c INHERITING FROM c_ref)	CL_AXT_EMBE_EMBEDWIZARD		20090306
3	Inheritance (c INHERITING FROM c_ref)	CL_AXT_RAPI_CUSTAPPTASKPA		20090302
4	Inheritance (c INHERITING FROM c_ref)	CL_EPM_DEMO_GUIDEDBUSPART		20100910
5	Inheritance (c INHERITING FROM c_ref)	CL_UIF_TBUI_GUIDEDFLIGHTB		20080724
6	Inheritance (c INHERITING FROM c_ref)	CL_WCF_CDS__GUIDEDPROCEDU		20100503

Properties

Class	CL_BSP_WD_GEN_ROADMAP_VS
Short Description	Generic ViewSet for configurable roadmaps
Super Class	CL_BSP_WD_DYN_VIEWSET	Dynamic Viewset base class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	BSP_DYN_LAYOUT_TB_UI_RUNTIME	Guided Activity Page runtime objects
Created	20080221	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_DLC_PROCESS_CONTROL	☐	☐	Roadmap Control Interface	20080429
2	IF_BSP_DLC_PROCESS_STEP	☐	☐	Roadmap Step Interface	20090126
3	IF_BSP_WD_DYN_BTN_CONTROL	☐	☐	Dynamic Button control Interface	20080429

Friends

Class CL_BSP_WD_GEN_ROADMAP_VS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_EVENT_FINISH_ROADMAP	Constant	Public	☐	Type reference (TYPE)	STRING	'FinishRoadMap'		20080415
2	CO_EVENT_NEXT_ROADMAP_ITEM	Constant	Public	☐	Type reference (TYPE)	STRING	'NextRoadMapItem'	Event 'Next'	20080225
3	CO_EVENT_PREFIX_DELEGATE	Constant	Public	☐	Type reference (TYPE)	STRING	'#TBUI#_'	Event prefix: Delegate these to embedded task pages	20090305
4	CO_EVENT_PREVIOUS_ROADMAP_ITEM	Constant	Public	☐	Type reference (TYPE)	STRING	'PreviousRoadMapItem'	Event 'Previous'	20080225
5	CO_TASK_LEFT	Constant	Public	☐	Type reference (TYPE)	I	-3	Task has been left	20090125
6	CO_TASK_LEFT_WITH_NEXT	Constant	Public	☐	Type reference (TYPE)	I	-2	Task has been left with 'Next'	20090125
7	CO_TASK_LEFT_WITH_PREVIOUS	Constant	Public	☐	Type reference (TYPE)	I	-1	Task has been left with 'Previous'	20090125
8	CO_VA_STAGE	Constant	Public	☐	Type reference (TYPE)	STRING	'Stage'	View area for step views	20080225
9	CO_VIEWID_PREFIX_REUSE_TASK	Constant	Public	☐	Type reference (TYPE)	STRING	'#TBRT#'	Reusable tasks from customizing	20090114
10	CO_VIEWID_PREFIX_REUSE_VIEW	Constant	Public	☐	Type reference (TYPE)	STRING	'#TBRV#'	Reusable views from customizing	20090114
11	CURRENT_HOST_CONTROLLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER		Basis Class for WD View Controller	20080307
12	CUST_API	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BSP_DLC_TBUI_CUST_API		Access to customizing of Task-Based UI	20081107
13	DATA_CONTEXT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_WCF_DATA_CONTEXT_SRV		Data Context	20081106
14	EMBEDDED_TASK_CONTR	Instance attribute	Private	☐	Type reference (TYPE)	BSPWD_TBUI_EMBEDDED_TASK_CONTR		Controllers of embedded task pages	20090304
15	EMBEDDING_DATA	Instance attribute	Public	☐	Object reference (TYPE REF TO)	BSPWD_TBUI_RENDER_EMBEDDING_T		Data to render for task embedding	20090116
16	EMBEDDING_STEP_ID	Instance attribute	Public	☐	Type reference (TYPE)	STRING	'0'	Step which embeds this task	20090116
17	GV_INITIAL_STEP	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20121122
18	GV_REQUEST_RESET_TASK	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20090608
19	GV_TASK_LEFT	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20090608
20	HIDE_STEP_VIEW_TRAY	Instance attribute	Public	☐	Type reference (TYPE)	FLAG		Hide Tray tag on step views	20090320
21	NAV_DATA_COLLECTION	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_BOL_BO_COL		Business Object Collection Interface	20080227
22	PS_TEXT_API	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_BSP_DLC_TBUI_PS_TXT_API		Process Step Text API	20080415
23	ROADMAP_CONTROL	Instance attribute	Public	☑	Object reference (TYPE REF TO)	IF_BSP_DLC_ROADMAP_CONTROL		Roadmap control interface	20080225
24	ROADMAP_SETUP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BSP_DLC_ROADMAP_SETUP		Task page configuration	20080304
25	UIOBJECT_USAGES	Instance attribute	Private	☐	Type reference (TYPE)	LTYPE_UIOBJ_USAGE_TAB			20080304
26	VIEW	Constant	Private	☐	Type reference (TYPE)	STRING	'../../sap/bsp_dlc_tbui/RoadMapFrame.htm'	View to render task page	20080225

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BIND_STEP_VIEW	Instance method	Private	Method	Binding step view (incl. home environm. of external views)	20081111
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20080225
3	EH_ONFINISHROADMAP	Instance method	Protected	Method		20080801
4	EH_REQUEST_RESET	Instance method	Protected	Event handling method		20090119
5	GET_DATA_CONTEXT	Instance method	Private	Method	Data Context for view/task being left	20090127
6	GET_INITIAL_STEP	Instance method	Public	Method	Return the initial step of the guided activity	20121123
7	GET_UI_OBJECT_USAGE	Instance method	Private	Method	OBSOLETE, DO NOT USE	20081112
8	GET_USAGE_DEF	Instance method	Private	Method	Usage definition for external view	20081104
9	INITIALIZE_SUBTASK_SELECTION	Instance method	Private	Method	Comunication with embedded task w.r.t. active step	20090127
10	IS_EMBEDDED	Instance method	Public	Method	Is this task page embedded into another task page?	20090116
11	REQUEST_RESET_TASK	Instance method	Public	Method		20090127
12	RESET_TASK	Instance method	Private	Method		20090206
13	SET_DATA_CONTEXT	Instance method	Private	Method	Data Context for view/task being navigated to	20090127
14	SET_EMBEDDING_DATA	Instance method	Private	Method	Comunication with embedded task to jointly render roadmap	20090116
15	SET_INITIAL_STEP	Instance method	Public	Method	Set the initial step of the guided activity	20121122
16	SET_TARGET_FROM_SUBTASK	Instance method	Private	Method	Comunication with embedded task w.r.t. target step	20090127
17	STATE_RESTORE	Instance method	Public	Method		20081106
18	STATE_STORE	Instance method	Public	Method		20081106

Events

Class CL_BSP_WD_GEN_ROADMAP_VS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTYPE_EMBEDDED_TASKS	Private	See coding			20090209	begin of LTYPE_EMBEDDED_TASKS, ID type STRING, EMBEDDED_CONTROLLER type ref to CL_BSP_WD_VIEW_CONTROLLER, end of LTYPE_EMBEDDED_TASKS
2	LTYPE_EMBEDDED_TASKS_TAB	Private	See coding			20090209	LTYPE_EMBEDDED_TASKS_TAB type standard table of LTYPE_EMBEDDED_TASKS with key ID
3	LTYPE_UIOBJ_USAGE	Private	See coding			20080304	begin of LTYPE_UIOBJ_USAGE, ID type STRING, HOST_CONTROLLER type ref to CL_BSP_WD_VIEW_CONTROLLER, HOST_REP_VIEW type ref to CL_BSP_WD_REP_VIEW, USAGE type ref to CL_BSP_WD_COMPONENT_USAGE, end of LTYPE_UIOBJ_USAGE
4	LTYPE_UIOBJ_USAGE_TAB	Private	See coding			20080304	LTYPE_UIOBJ_USAGE_TAB type hashed table of LTYPE_UIOBJ_USAGE with unique key ID

Method Signatures

Method BIND_STEP_VIEW Signature

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

Method BIND_STEP_VIEW on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method CONSTRUCTOR Signature

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

Method EH_ONFINISHROADMAP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HTMLB_EVENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_HTMLB_EVENT			20080801
2	Importing	HTMLB_EVENT_EX	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTMLB_DATA			20080801

Method EH_ONFINISHROADMAP on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method EH_REQUEST_RESET Signature

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

Method GET_DATA_CONTEXT Signature

Method GET_DATA_CONTEXT on class CL_BSP_WD_GEN_ROADMAP_VS has no parameter.
Method GET_DATA_CONTEXT on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method GET_INITIAL_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_INITIAL_STEP	Value transfer	☐	Type reference (TYPE)	STRING		Initial step or initial view name	20121123

Method GET_INITIAL_STEP on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method GET_UI_OBJECT_USAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20081112
2	Returning	RS_RESULT	Value transfer	☐	Type reference (TYPE)	LTYPE_UIOBJ_USAGE			20081112

Method GET_UI_OBJECT_USAGE on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method GET_USAGE_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	BSP_WD_COMPONENT_NAME		Component Name	20081118
2	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	O2PAGEEXT		Name of BSP Page (Upper and Lower Case)	20081105
3	Returning	RS_RESULT	Value transfer	☐	Type reference (TYPE)	LTYPE_UIOBJ_USAGE			20081104

Method GET_USAGE_DEF on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method INITIALIZE_SUBTASK_SELECTION Signature

Method INITIALIZE_SUBTASK_SELECTION on class CL_BSP_WD_GEN_ROADMAP_VS has no parameter.
Method INITIALIZE_SUBTASK_SELECTION on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method IS_EMBEDDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EMBEDDED	Value transfer	☐	Type reference (TYPE)	FLAG		Is this task embedded into another task?	20090116

Method IS_EMBEDDED on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method REQUEST_RESET_TASK Signature

Method REQUEST_RESET_TASK on class CL_BSP_WD_GEN_ROADMAP_VS has no parameter.
Method REQUEST_RESET_TASK on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method RESET_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORCE_RESET	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090310

Method RESET_TASK on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method SET_DATA_CONTEXT Signature

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

Method SET_DATA_CONTEXT on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method SET_EMBEDDING_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DATA_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	CL_WCF_DATA_CONTEXT_SRV			20090128
2	Importing	IR_EMBEDDING_DATA	Call by reference	☐	Object reference (TYPE REF TO)	BSPWD_TBUI_RENDER_EMBEDDING_T		Data to render for task embedding	20090121
3	Importing	IV_STEP_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090116

Method SET_EMBEDDING_DATA on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method SET_INITIAL_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP	Value transfer	☐	Type reference (TYPE)	STRING		Step number or view name	20121122

Method SET_INITIAL_STEP on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method SET_TARGET_FROM_SUBTASK Signature

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

Method SET_TARGET_FROM_SUBTASK on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method STATE_RESTORE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATE_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_WD_HISTORY_STATE_CONT		Interface for a name/value-pair based container	20081106

Method STATE_RESTORE on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

Method STATE_STORE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATE_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_WD_HISTORY_STATE_CONT		Interface for a name/value-pair based container	20081106

Method STATE_STORE on class CL_BSP_WD_GEN_ROADMAP_VS has no exception.

History

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