SAP ABAP Class /IWBEP/IF_SBUI_CONTROLLER (SB: UI controller (main instance))

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/IWBEP/CL_SBUI_CONTROLLER	SB: UI main controller	20120117

Properties

Class	/IWBEP/IF_SBUI_CONTROLLER
Short Description	SB: UI controller (main instance)
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package
Created	20120113	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWBEP/IF_SBCM_MSG_OBJECT	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	/IWBEP/IF_SBUI_COMPONENT	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	/IWBEP/IF_SBUI_CONTROLLER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	/IWBEP/IF_SBUI_FILTER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	/IWBEP/IF_SBUI_INTERACTIVE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
6	/IWBEP/IF_SBUI_SETUP_SERVICE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
7	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class /IWBEP/IF_SBUI_CONTROLLER has no interface implemented.

Friends

Class /IWBEP/IF_SBUI_CONTROLLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CC_SB_BACK	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_BACK'	fcode: back	20120507
2	GC_CC_SB_CANCEL	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_CANCEL'	fcode: cancel input processing	20120227
3	GC_CC_SB_DETAIL	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_DETAIL'	fcode: cancel input processing	20120615
4	GC_CC_SB_ENTER	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_ENTER'	fcode: check data input	20120301
5	GC_CC_SB_FINISH	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_FINISH'	fcode: finish processing	20120507
6	GC_CC_SB_HIDE	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_HIDE'	fcode: hide current view	20130413
7	GC_CC_SB_NEXT	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_NEXT'	fcode: go to next tool	20120507
8	GC_CC_SB_PREV	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_PREV'	fcode: go to previous tool	20120712
9	GC_CC_SB_UPDATE	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB_UPDATE'	fcode: update display	20120216
10	GC_FC_PREFIX_BUILT_IN	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SB'	fcode prefix: service builder commands (built-in)	20120206
11	GC_FC_PREFIX_INTERNAL	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	SPACE	fcode prefix: internal commands, sent by controller	20120206
12	GC_FC_PREFIX_LOCAL	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'L'	fcode prefix: local commands, used within a component	20120206
13	GC_FC_PREFIX_LOCAL_NAV	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'L_NAV'	fcode prefix: local navigation command	20130424
14	GC_FC_PREFIX_SEPARATOR	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'_'	fcode prefix separator	20120206
15	GC_IC_SB_FLUSH	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'_FLUSH'	internal fcode: trigger PAI out of system event	20120129
16	GC_IC_SB_FREE	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'_FREE'	internal fcode: free instance	20120620
17	GC_IC_SB_SELECT	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'_SELECT'	internal fcode: query for selection	20120224
18	GC_IC_SB_SETUP	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'_SETUP'	internal fcode: setup component	20120427
19	GC_LC_WZ_BACK	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'L_WZ_BACK'	fcode: wizard step back	20120510
20	GC_LC_WZ_NEXT	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'L_WZ_NEXT'	fcode: wizard step next	20120510
21	GC_RC_CANCELLED	Constant	Public	☐	Type reference (TYPE)	TY_RETURN_CODE	'C'	return code: cancelled (by user)	20120129
22	GC_RC_ERROR	Constant	Public	☐	Type reference (TYPE)	TY_RETURN_CODE	'E'	return code: error	20120129
23	GC_RC_REJECTED	Constant	Public	☐	Type reference (TYPE)	TY_RETURN_CODE	'R'	return code: rejected (by user)	20120224
24	GC_RC_SUCCESS	Constant	Public	☐	Type reference (TYPE)	TY_RETURN_CODE	'S'	return code: success	20120129
25	GC_RC_UNDEFINED	Constant	Public	☐	Type reference (TYPE)	TY_RETURN_CODE	SPACE	return code: undefined (not handled)	20120129
26	GC_RC_WARNING	Constant	Public	☐	Type reference (TYPE)	TY_RETURN_CODE	'W'	return code: warning	20120225

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_GUIDED_ACTIVITY	Instance method	Public	Method	call modal wizard for guided activity (registered in setup)	20120506
2	CALL_MODAL_DIALOG	Instance method	Public	Method	call modal dialog (registered in the setup)	20120128
3	EXECUTE_COMMAND	Instance method	Public	Method	execute command synchronously (registered in setup)	20120225
4	FREE_SHARED_VIEW	Instance method	Public	Method	free shared view from master view	20130508
5	GET_ACTIVE_EDIT_TOOL	Instance method	Public	Method	get active edit tool (component)	20130419
6	GET_ATTACHED_ROOT_NODES	Instance method	Public	Method	get attached root nodes (all visible root nodes)	20120201
7	GET_EXCLUDED_FCODES	Instance method	Public	Method	get excluded function codes (without dynamic checks)	20120509
8	GET_MAIN_WINDOW_SIZE	Instance method	Public	Method	get main window size (size of service builder main window)	20120127
9	GET_MESSAGE_UTILITY	Instance method	Public	Method	get message utility (supports message tree handling)	20120116
10	GET_NAVIGATION_ELEMENT	Instance method	Public	Method	get navigation element for one node (compares node path)	20120715
11	GET_NAVIGATION_STATE	Instance method	Public	Method	get navigation state (current node selection and element)	20120509
12	GET_NAV_FOLDER_ELEMENT	Instance method	Public	Method	get navigation element for child folder (based on setup)	20130703
13	GET_NAV_PARENT_TARGET	Instance method	Public	Method	get navigation parent target (based on navigation method)	20130704
14	GET_SETUP_SERVICE	Instance method	Public	Method	get setup service (public read accesss to setup data)	20120116
15	IS_ROOT_NODE_ATTACHED	Instance method	Public	Method	check whether root is attached (means part of visible roots)	20120201
16	LINK_SHARED_VIEW	Instance method	Public	Method	links shared view to master view (access on before output)	20130508
17	ON_COMMAND_REQUESTED	Instance method	Public	Method	notify of command request (asynchronous execution via queue)	20120216
18	ON_CTMENU_REQUESTED	Instance method	Public	Method	notify of context menu requested	20120223
19	ON_DYNPRO_BEFORE_OUTPUT	Instance method	Public	Method	notify of process before output	20120315
20	ON_INPUT_FLUSH_REQUIRED	Instance method	Public	Method	notify of user input data flush required	20130821
21	ON_INPUT_VALIDATION	Instance method	Public	Method	notify of user input validation	20120214
22	ON_MESSAGES_RAISED	Instance method	Public	Method	notify of message(s) raised	20120202
23	ON_NAVIGATION_REQUESTED	Instance method	Public	Method	notify of navigation request	20120202
24	ON_SELECTION_CHANGED	Instance method	Public	Method	notify of selection change request	20130510
25	POPUP_TO_APPROVE	Instance method	Public	Method	popup to approve critical step	20130806
26	POPUP_TO_CONFIRM	Instance method	Public	Method	popup to confirm	20120224
27	POPUP_TO_SELECT_DATA	Instance method	Public	Method	popup to select single table entry	20120925
28	POPUP_TO_SELECT_NAME	Instance method	Public	Method	popup to select one name using a finder	20130620
29	POPUP_TO_SELECT_NODE	Instance method	Public	Method	popup to select single node by name and description	20120229
30	PROVIDE_EXTENSION	Instance method	Public	Method	provide extension handler instance (registered in setup)	20130221
31	UPDATE_TOOLBAR_STATE	Instance method	Public	Method	update status of toolbar elements (ignores local commands)	20120712

Events

Class /IWBEP/IF_SBUI_CONTROLLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_RETURN_CODE	Public	See coding		return code from command processing (see constants)	20120129	ty_return_code TYPE c LENGTH 1
2	TY_S_COMMAND_REQUEST	Public	See coding		command request for interactive components	20120129	BEGIN OF ty_s_command_request , fcode TYPE syucomm , targets TYPE ty_t_navigation_target , nodes TYPE /iwbep/t_sbdm_nodes , param TYPE REF TO data , END OF ty_s_command_request
3	TY_S_DELTA_ANONYMOUS	Public	See coding		delta information on anonymous object	20130408	BEGIN OF ty_s_delta_anonymous , object TYPE REF TO object , insert TYPE abap_bool , remove TYPE abap_bool , update TYPE ty_s_delta_anonymous_update , END OF ty_s_delta_anonymous
4	TY_S_DELTA_ANONYMOUS_UPDATE	Public	See coding		delta information on updated anonymous objects	20130408	BEGIN OF ty_s_delta_anonymous_update , data TYPE abap_bool , END OF ty_s_delta_anonymous_update
5	TY_S_DELTA_NODE	Public	See coding		delta information on node (created, updated, deleted)	20120228	BEGIN OF ty_s_delta_node , node TYPE REF TO /iwbep/if_sbdm_node , insert TYPE abap_bool , remove TYPE abap_bool , update TYPE ty_s_delta_node_update , END OF ty_s_delta_node
6	TY_S_DELTA_NODE_UPDATE	Public	See coding		delta information on updated nodes	20120228	BEGIN OF ty_s_delta_node_update , properties TYPE abap_bool , data TYPE abap_bool , associations TYPE abap_bool , assc_to_parent TYPE abap_bool , assc_to_children TYPE abap_bool , END OF ty_s_delta_node_update
7	TY_S_NAVIGATION_STATE	Public	See coding		navigation state	20120312	BEGIN OF ty_s_navigation_state , target TYPE ty_s_navigation_target, " node that the selection of the visible edit tool is based on marked TYPE ty_t_navigation_target, " marked nodes with next related navigation element (visible in navigation tree) marked_nodes TYPE /iwbep/t_sbdm_nodes, " marked nodes as a simlpe object table END OF ty_s_navigation_state
8	TY_S_NAVIGATION_TARGET	Public	See coding		navigation target (element, item, node)	20120614	BEGIN OF ty_s_navigation_target , element TYPE /iwbep/if_sbui_setup_service=>ty_s_navigation_target , node TYPE REF TO /iwbep/if_sbdm_node , origin TYPE REF TO /iwbep/if_sbdm_node , object TYPE REF TO object , END OF ty_s_navigation_target
9	TY_S_PARAMETER_MAP	Public	See coding		interactive component member to parameter map	20120426	BEGIN OF ty_s_parameter_map , name TYPE string , member TYPE REF TO data , END OF ty_s_parameter_map
10	TY_S_SHARED_VIEW	Public	See coding		linked shared view	20130508	BEGIN OF ty_s_shared_view , plugin TYPE /iwbep/sbui_plugin , name TYPE /iwbep/sbui_component , handler TYPE REF TO /iwbep/if_sbui_interactive , END OF ty_s_shared_view
11	TY_S_TEXT_PARAM	Public	See coding		text parameter	20130806	BEGIN OF ty_s_text_param , name TYPE spar-param , value TYPE spar-value , END OF ty_s_text_param
12	TY_S_UPDATE_STATE	Public	See coding		state information provided on update before output	20120312	BEGIN OF ty_s_update_state , navigation_state TYPE ty_s_navigation_state , " current selected navigation target navigation_mandatory TYPE abap_bool , " navigation triggered explicitly, no option for lazy update selection_mandatory TYPE abap_bool , " selection changed explicitly, no option for lazy update selection_sender TYPE REF TO /iwbep/if_sbui_command_handler , " selection changed by this sender finally marked_composite TYPE abap_bool , " selection logically covers whole subtree reload_requested TYPE /iwbep/t_sbui_interactive , " reload mandatory for these components, no lazy reload changed_nodes TYPE ty_t_delta_node , " changed domain model nodes changed_anonymous TYPE ty_t_delta_anonymous , " changed anonymous external objects excluded_fcodes TYPE ty_t_command_fcode , " disabled function codes message_buffer TYPE /iwbep/if_sbcm_msg_object=>ty_t_object , " messages collected within roundtrip message_refresh TYPE abap_bool , " message buffer is to be refreshed END OF ty_s_update_state
13	TY_T_COMMAND_FCODE	Public	See coding		command fcode table	20120130	ty_t_command_fcode TYPE SORTED TABLE OF syucomm WITH UNIQUE KEY table_line
14	TY_T_DELTA_ANONYMOUS	Public	See coding		delta information on anonymous objects	20130408	ty_t_delta_anonymous TYPE SORTED TABLE OF ty_s_delta_anonymous WITH UNIQUE KEY object
15	TY_T_DELTA_NODE	Public	See coding		delta information on nodes	20120228	ty_t_delta_node TYPE SORTED TABLE OF ty_s_delta_node WITH UNIQUE KEY node
16	TY_T_NAVIGATION_STATE	Public	See coding		navigation state table	20120313	ty_t_navigation_state TYPE STANDARD TABLE OF ty_s_navigation_state WITH DEFAULT KEY
17	TY_T_NAVIGATION_TARGET	Public	See coding		navigation target table	20120614	ty_t_navigation_target TYPE STANDARD TABLE OF ty_s_navigation_target WITH DEFAULT KEY
18	TY_T_PARAMETER_MAP	Public	See coding		interactive component member to parameter map	20120426	ty_t_parameter_map TYPE SORTED TABLE OF ty_s_parameter_map WITH UNIQUE KEY name
19	TY_T_ROOT_NODE	Public	See coding		root node collection	20120202	ty_t_root_node TYPE SORTED TABLE OF REF TO /iwbep/if_sbdm_root WITH UNIQUE KEY table_line
20	TY_T_SHARED_VIEW	Public	See coding		linked shared view table	20130508	ty_t_shared_view TYPE SORTED TABLE OF ty_s_shared_view WITH UNIQUE KEY plugin name
21	TY_T_TEXT_PARAM	Public	See coding		text parameter table	20130806	ty_t_text_param TYPE SORTED TABLE OF ty_s_text_param WITH UNIQUE KEY name

Method Signatures

Method CALL_GUIDED_ACTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		start node	20120718
2	Importing	IT_NODE	Call by reference	☑	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		start nodes	20120506
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY		name (from setup)	20120506
4	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin (from setup)	20120506
5	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	TY_RETURN_CODE		return code	20120506

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120506

Method CALL_MODAL_DIALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		start node (initial node selection; default==current)	20120716
2	Importing	IT_NODE	Call by reference	☑	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		start nodes (initial node selection; default==current)	20120717
3	Importing	IV_ARGS	Call by reference	☑	Type reference (TYPE)	ANY		start arguments (type is defined by dialog handler)	20130202
4	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_COMPONENT		name (from setup)	20120128
5	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin (from setup)	20120128
6	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	TY_RETURN_CODE		return code	20120129

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120128

Method EXECUTE_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMMAND_HANDLER		calling command instance	20120228
2	Importing	IO_NODE	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		start node	20120718
3	Importing	IT_NODE	Call by reference	☑	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		node selection	20120225
4	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_COMMAND		name (from setup)	20120227
5	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin (from setup)	20120227
6	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	TY_RETURN_CODE		return code (see constants)	20120225

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120225

Method FREE_SHARED_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MASTER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_VIEW		master view	20130508
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_COMPONENT		name (from setup)	20130508
3	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin (from setup)	20130508

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130508

Method GET_ACTIVE_EDIT_TOOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_TOOL	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMPONENT		component	20130419

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130419

Method GET_ATTACHED_ROOT_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ROOT_NODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/T_SBDM_ROOTS		attached root nodes	20120202

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120202

Method GET_EXCLUDED_FCODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FCODE_EXCLUDE	Value transfer	☐	Type reference (TYPE)	TY_T_COMMAND_FCODE		excluded function codes	20120509

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120509

Method GET_MAIN_WINDOW_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_METRIC	Call by reference	☑	Type reference (TYPE)	/IWBEP/IF_SBUI_COMPONENT=>TY_METRIC		requested metric	20120127
2	Returning	RS_SIZE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_COMPONENT=>TY_S_SIZE		calculated size	20120127

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120127

Method GET_MESSAGE_UTILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_UTILITY	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBCM_MSG_UTILITY		message utility instance	20120116

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120116

Method GET_NAVIGATION_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		node for which the navigation element needs to be selected	20120715
2	Returning	RS_ELEMENT	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_NAVIGATION_TARGET		navigation target (perspective, element, item, category)	20120715

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120715

Method GET_NAVIGATION_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_NAVIGATION_STATE	Call by reference	☐	Type reference (TYPE)	TY_S_NAVIGATION_STATE		navigation state	20120509

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120509

Method GET_NAV_FOLDER_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		node for which the navigation element needs to be selected	20130703
2	Importing	IS_CHILD_TYPE	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_SBDM_NODE_TYPE		child node type	20130703
3	Importing	IV_CHILD_CATEGORY	Call by reference	☑	Type reference (TYPE)	/IWBEP/IF_SBUI_FILTER=>TY_CATEGORY	SPACE	child node category	20130703
4	Returning	RS_ELEMENT	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_NAVIGATION_TARGET		navigation target (perspective, element, item, category)	20130703

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130703

Method GET_NAV_PARENT_TARGET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_TARGET	Call by reference	☐	Type reference (TYPE)	TY_S_NAVIGATION_TARGET		navigation target (perspective, element, item, node)	20130704
2	Returning	RS_PARENT	Value transfer	☐	Type reference (TYPE)	TY_S_NAVIGATION_TARGET		parent navigation target	20130704

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130704

Method GET_SETUP_SERVICE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SERVICE	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_SETUP_SERVICE		setup service	20120116

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120116

Method IS_ROOT_NODE_ATTACHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		node to determine the root node from	20120201
2	Returning	RV_ATTACHED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		root attached or not?	20120201

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120201

Method LINK_SHARED_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MASTER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_VIEW		master view	20130508
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_COMPONENT		name (from setup)	20130508
3	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin (from setup)	20130508
4	Returning	RO_SHARED	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		shared view handler	20131104

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130508

Method ON_COMMAND_REQUESTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		selected simple node	20120321
2	Importing	IO_SENDER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMMAND_HANDLER		sending command handler	20120216
3	Importing	IS_TARGET	Call by reference	☑	Type reference (TYPE)	/IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_NAVIGATION_TARGET		navigation target used for simple nodes	20120614
4	Importing	IT_NODE	Call by reference	☑	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		selected simple nodes	20120216
5	Importing	IT_TARGET	Call by reference	☑	Type reference (TYPE)	TY_T_NAVIGATION_TARGET		navigation target node table	20130208
6	Importing	IV_FCODE	Call by reference	☐	Type reference (TYPE)	SYUCOMM		function code that PAI triggered	20120216
7	Importing	IV_SELECT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	update selection before execution	20120910

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120216

Method ON_CTMENU_REQUESTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MENU	Call by reference	☐	Object reference (TYPE REF TO)	CL_CTMENU		context menu	20120223
2	Importing	IO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		domain model node	20120223
3	Importing	IO_SENDER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		sending interactive component	20120223
4	Importing	IS_TARGET	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_NAVIGATION_TARGET		navigation target (element, item)	20120223

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120223

Method ON_DYNPRO_BEFORE_OUTPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SENDER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/CL_SBUI_DYNPRO_HANDLER		sending dynpro handler (state of a screen)	20120315

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120315

Method ON_INPUT_FLUSH_REQUIRED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SENDER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMMAND_HANDLER		sending command handler	20130821

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130821

Method ON_INPUT_VALIDATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SENDER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		sending interactive component	20120214
2	Returning	RV_SKIP	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		skip validation (while exit command active)	20120622

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120214

Method ON_MESSAGES_RAISED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_SBCM_MSG_OBJECT		message (the root of a message tree)	20120202
2	Importing	IO_SENDER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMMAND_HANDLER		sending command handler	20120202
3	Importing	IT_MESSAGE	Call by reference	☑	Type reference (TYPE)	/IWBEP/IF_SBCM_MSG_OBJECT=>TY_T_OBJECT		message collection	20120202
4	Importing	IV_REFRESH	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	cleanup notifcation area before output	20120202

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120214

Method ON_NAVIGATION_REQUESTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		navigation target node (e.g. where tree was double-clicked)	20120215
2	Importing	IO_OBJECT	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT		navigation target object (anonymous, in scope of IO_NODE)	20131031
3	Importing	IO_SENDER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMMAND_HANDLER		sending command handler	20120202
4	Importing	IS_TARGET	Call by reference	☑	Type reference (TYPE)	/IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_NAVIGATION_TARGET		navigation target (perspective, element, item, category)	20120216
5	Importing	IT_SELECT	Call by reference	☑	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		nodes to be selected (by default target node is selected)	20130511
6	Importing	IV_FOLDER	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	prefer element folder (if defined by current perspective)	20130511
7	Importing	IV_RETURN	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	return new navigation state to previous screen in call stack	20131002
8	Importing	IV_SELECT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	selection update is mandatory for all components	20130701
9	Importing	IV_STABLE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	stable edit tool state, do not switch to default view	20130704

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120214

Method ON_SELECTION_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		selected node	20130510
2	Importing	IO_SENDER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMMAND_HANDLER		sending command handler	20130510
3	Importing	IT_NODE	Call by reference	☑	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		selected nodes	20130510

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130510

Method POPUP_TO_APPROVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_COMMAND	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMMAND		use command description as title	20130806
2	Importing	IT_PARAM	Call by reference	☑	Type reference (TYPE)	TY_T_TEXT_PARAM		text parameter table	20130806
3	Importing	IV_ICON	Call by reference	☑	Type reference (TYPE)	ICON-NAME		icon name as string, e.g. 'ICON_MESSAGE_CRITICAL'	20130806
4	Importing	IV_QUESTION	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		question text (with &PARAMS&, up to about 400 chars)	20130806
5	Importing	IV_TITLE	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		dialog title text (up to 60 chars)	20130806
6	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	TY_RETURN_CODE		return code (success, rejected or cancelled)	20130806

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130806

Method POPUP_TO_CONFIRM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_COMMAND	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_COMMAND		use command description as title	20120224
2	Importing	IV_CANCEL	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	display cancel button	20120224
3	Importing	IV_TEXT_1	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		text line 1 (up to 70 chars)	20120225
4	Importing	IV_TEXT_2	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		text line 2 (up to 70 chars)	20120225
5	Importing	IV_TITLE	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		dialog title text (up to 70 chars)	20120224
6	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	TY_RETURN_CODE		return code (success, rejected or cancelled)	20120224

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120224

Method POPUP_TO_SELECT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RCODE	Call by reference	☐	Type reference (TYPE)	TY_RETURN_CODE		return code (success, cancelled)	20120925
2	Exporting	EV_SELECTED	Call by reference	☐	Type reference (TYPE)	SYTABIX		selected entry (table index)	20120925
3	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		data table	20120925
4	Importing	IV_READONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		read-only mode?	20120925
5	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	DD02L-TABNAME		display structure (visible fields, subset of table fields)	20120925
6	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		dialog title	20120925

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120925

Method POPUP_TO_SELECT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		selected node	20140319
2	Exporting	ES_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_SBDM_QUAL_NAME		qualified name	20130620
3	Exporting	EV_RCODE	Call by reference	☐	Type reference (TYPE)	TY_RETURN_CODE		return code (success, cancelled)	20130620
4	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		context node (where to use the name)	20130620
5	Importing	IV_FINDER	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBDM_FINDER		finder name (extension key)	20130620
6	Importing	IV_READONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		read-only mode?	20130620
7	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		dialog title	20130620

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130620

Method POPUP_TO_SELECT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_SELECTED	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		selected node (if not cancelled)	20120229
2	Exporting	EV_RCODE	Call by reference	☐	Type reference (TYPE)	TY_RETURN_CODE		return code (success, cancelled)	20120229
3	Importing	IT_NODE	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		available nodes	20120229
4	Importing	IV_READONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		read-only mode?	20120229
5	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		dialog title	20120229

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120229

Method PROVIDE_EXTENSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		extension key (from setup, specific data element)	20130221
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBDM_EXTENSION_POINT		extension point name (from setup)	20130221
3	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		extension point plugin (from setup, calls the extension)	20130221
4	Returning	RO_EXTENSION	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_EXTENSION		extension handler (from implementation plugin)	20130221

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130221

Method UPDATE_TOOLBAR_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_BUTTON	Call by reference	☐	Type reference (TYPE)	TTB_BUTTON		defined toolbar buttons	20120712
2	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_NODE		context node in toolbar scope (e.g. parent of table entries)	20130214
3	Importing	IS_TARGET	Call by reference	☑	Type reference (TYPE)	/IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_NAVIGATION_TARGET		navigation target (element, item)	20120712
4	Importing	IT_NODE	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		nodes in the toolbar scope (e.g. table entries)	20120712

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120712

History

Last changed by/on	SAP	20141120
SAP Release Created in