SAP ABAP Class /IWBEP/CL_SBUI_GUIDED_ACTIVITY (SB: UI guided activity (convenience class))

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-BSE-SB (Application Component) Gateway Service Builder
     ⤷ /IWBEP/SB_UI_BASE (Package) Gateway Service Builder UI - API and SPI

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/IWBEP/IF_SBCM_MSG_CONTEXT	SB: message context	20120508
2	Interface implementation (CLASS c. INTERFACES i_ref)	/IWBEP/IF_SBUI_COMMAND_HANDLER	SB: UI command handler behavior	20120425
3	Interface implementation (CLASS c. INTERFACES i_ref)	/IWBEP/IF_SBUI_GUIDED_ACTIVITY	SB: UI guided activity	20120423

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_APC_GUID_ACTY	SB: Guided Activity for Modification generator	20140129
2	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_CE_ACTIVITY	SB: UI Create Entity guided activity	20120509
3	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_CR_GUID_ACTY	Guided Activity for Create service	20120606
4	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_FL_ACTIVITY	SB: UI File Import Guided Activity	20130308
5	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_MG_GUID_ACTY	SB: Guided Activity for Modification generator	20120507
6	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_OD_ASSO_WIZ_ACT	SB: OD association wizard guided activity	20121002
7	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_TM_ACT_IMPORT	SB: UI template guided activity	20120511
8	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_TM_ACT_SIMPLE	SB: UI template guided activity	20120511

Properties

Class	/IWBEP/CL_SBUI_GUIDED_ACTIVITY
Short Description	SB: UI guided activity (convenience class)
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class	/IWBEP/SBUI
Program status	P	SAP Standard Production Program
Category	0
Package	/IWBEP/SB_UI_BASE	Gateway Service Builder UI - API and SPI
Created	20120423	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWBEP/IF_SBUI_CONTROLLER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/IWBEP/IF_SBCM_MSG_CONTEXT	☐	☑	SB: message context	20120508
2	/IWBEP/IF_SBUI_COMMAND_HANDLER	☐	☑	SB: UI command handler behavior	20120425
3	/IWBEP/IF_SBUI_GUIDED_ACTIVITY	☐	☑	SB: UI guided activity	20120423

Friends

Class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_CONTROLLER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_CONTROLLER		controller (main instance)	20120425
2	MO_SETUP_FACTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_SETUP_FACTORY		setup factory for controller	20120711
3	MO_SETUP_SERVICE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_SETUP_SERVICE		setup service for components	20120711
4	MO_TRANSACTION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBDM_TRANSACTION		sessions transaction instance	20120514
5	MR_CURRENT_STEP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	TY_S_STEP		step currently in process	20120507
6	MS_NAME	Instance attribute	Protected	☐	Attribute reference (LIKE)				20120507
7	MT_DEFINED_STEP	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_STEP		step sequence	20120507
8	MT_RUN_CONTEXT	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		run context nodes	20140207
9	MV_ENABLE_BACK	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		exclude command BACK	20120510
10	MV_ENABLE_FINISH	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		exclude command FINISH	20120510
11	MV_ENABLE_NEXT	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		exclude command NEXT	20120510
12	MV_RUN_PRIVILEGED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		run finalize in privileged mode	20140207

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20120425
2	CREATE_STEP_WITH_SUBSCREEN	Instance method	Protected	Method	utility: create step based on a subscreen	20120425
3	CREATE_STEP_WITH_VIEW	Instance method	Protected	Method	utility: create step based on a control-based view	20120425
4	DELETE_STEP_DEFINITION	Instance method	Protected	Method	utility: delete step definition (before processing only)	20120507
5	DO_BEFORE_CANCEL_PROCESSING	Instance method	Protected	Method	template method (optional): before cancellation of wizard	20120524
6	DO_BEFORE_CANCEL_STEP	Instance method	Protected	Method	template method (optional): before going back one step	20120524
7	DO_CHECK_AFTER_INPUT	Instance method	Protected	Method	template method (optional): check step data after input	20120425
8	DO_EXECUTE_COMMAND	Instance method	Protected	Method	template method (optional): execute specific command	20120507
9	DO_FINALIZE_PROCESSING	Instance method	Protected	Method	template method (optional): finish whole guided activity	20120425
10	DO_FINALIZE_STEP	Instance method	Protected	Method	template method (optional): finalize step processing	20120506
11	DO_INITIALIZE_STEP	Instance method	Protected	Method	template method (optional): initialize step processing	20130415
12	DO_PROPOSE_CLIENT_SIZE	Instance method	Protected	Method	template method (optional): propose client size (one time)	20120525
13	DO_SETUP_INSTANCE	Instance method	Protected	Method	template method (mandatory): setup steps before start	20120425
14	DO_UPDATE_BEFORE_OUTPUT	Instance method	Protected	Method	template method (optional): update step before output	20120425
15	ENABLE_FINALIZE_PRIVILEGED	Instance method	Protected	Method	utility: enable finalize in privileged mode	20140207
16	ENABLE_FINALIZE_PROCESSING	Instance method	Protected	Method	utility: enable finalize (button FINISH) before last step	20120508
17	GET_CURRENT_HANDLER	Instance method	Protected	Method		20120510
18	GET_CURRENT_LONGTEXT	Instance method	Protected	Method		20120510
19	GET_CURRENT_POSITION	Instance method	Protected	Method		20120510
20	GET_CURRENT_TITLE	Instance method	Protected	Method		20120510
21	GET_EXCLUDED_COMMANDS	Instance method	Protected	Method		20120510
22	GET_TOTAL_STEP_COUNT	Instance method	Protected	Method		20120510
23	UPDATE_INFO_WITH_MESSAGE	Instance method	Protected	Method	utility: update description of one defined step	20120508

Events

Class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_NAME	Protected	Attribute reference (LIKE)			20120507
2	TY_S_STEP	Private	See coding		step data	20120510	BEGIN OF ty_s_step , number TYPE /iwbep/sbui_activity_step , position TYPE /iwbep/sbui_activity_step , subscreen TYPE REF TO /iwbep/cl_sbui_subscreen , dynpro_handler TYPE REF TO /iwbep/cl_sbui_dynpro_handler , step_handler TYPE REF TO /iwbep/if_sbui_interactive , syncpoint TYPE guid_16 , message TYPE /iwbep/if_sbcm_msg_object=>ty_s_data , longtext TYPE string , END OF ty_s_step
3	TY_T_STEP	Private	See coding		step table	20120426	ty_t_step TYPE SORTED TABLE OF ty_s_step WITH UNIQUE KEY number

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_CONTROLLER		controller (main instance)	20120425
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY		activity name	20120427
3	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		activity plugin	20120427

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

Method CREATE_STEP_WITH_SUBSCREEN 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)	/IWBEP/SBUI_COMPONENT		name (from setup)	20120508
2	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin (from setup)	20120508
3	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120508
4	Returning	RO_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20120508

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

Method CREATE_STEP_WITH_VIEW 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)	/IWBEP/SBUI_COMPONENT		name (from setup)	20120508
2	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin (from setup)	20120508
3	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120508
4	Returning	RO_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20120508

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

Method DELETE_STEP_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120508

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

Method DO_BEFORE_CANCEL_PROCESSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20120524
2	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120524

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

Method DO_BEFORE_CANCEL_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20120524
2	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120524

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

Method DO_CHECK_AFTER_INPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20120508
2	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120508
3	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120507

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

Method DO_EXECUTE_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_COMMAND	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_S_COMMAND_REQUEST		command request	20120507
2	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120507

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

Method DO_FINALIZE_PROCESSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20120508
2	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120508
3	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120507

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

Method DO_FINALIZE_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20120508
2	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120508
3	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120507

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

Method DO_INITIALIZE_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20130415
2	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20130415
3	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20130415

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

Method DO_PROPOSE_CLIENT_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_SIZE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_COMPONENT=>TY_S_SIZE		size	20120525

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

Method DO_SETUP_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_START	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		start nodes	20120508
2	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120525

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

Method DO_UPDATE_BEFORE_OUTPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		step handler	20120508
2	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120508

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

Method ENABLE_FINALIZE_PRIVILEGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENABLED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		indicates whether or not finalize runs in privileged mode	20140207

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

Method ENABLE_FINALIZE_PROCESSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENABLED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		finish button enabled or not?	20120508

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

Method GET_CURRENT_HANDLER Signature

Method GET_CURRENT_HANDLER on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no parameter.
Method GET_CURRENT_HANDLER on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no exception.

Method GET_CURRENT_LONGTEXT Signature

Method GET_CURRENT_LONGTEXT on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no parameter.
Method GET_CURRENT_LONGTEXT on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no exception.

Method GET_CURRENT_POSITION Signature

Method GET_CURRENT_POSITION on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no parameter.
Method GET_CURRENT_POSITION on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no exception.

Method GET_CURRENT_TITLE Signature

Method GET_CURRENT_TITLE on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no parameter.
Method GET_CURRENT_TITLE on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no exception.

Method GET_EXCLUDED_COMMANDS Signature

Method GET_EXCLUDED_COMMANDS on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no parameter.
Method GET_EXCLUDED_COMMANDS on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no exception.

Method GET_TOTAL_STEP_COUNT Signature

Method GET_TOTAL_STEP_COUNT on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no parameter.
Method GET_TOTAL_STEP_COUNT on class /IWBEP/CL_SBUI_GUIDED_ACTIVITY has no exception.

Method UPDATE_INFO_WITH_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID		message class id	20120508
2	Importing	IV_MSGNO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		message number	20120508
3	Importing	IV_MSGV1	Call by reference	☑	Type reference (TYPE)	SYMSGV		message variable	20120508
4	Importing	IV_MSGV2	Call by reference	☑	Type reference (TYPE)	SYMSGV		message variable	20120508
5	Importing	IV_MSGV3	Call by reference	☑	Type reference (TYPE)	SYMSGV		message variable	20120508
6	Importing	IV_MSGV4	Call by reference	☑	Type reference (TYPE)	SYMSGV		message variable	20120508
7	Importing	IV_STEP	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_ACTIVITY_STEP		step number	20120508

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

History

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