SAP ABAP Class CL_UPARM_CUSTOM_EVENT (Custom Event Handler Class)

Hierarchy

☛ BI_CONT (Software Component) Business Intelligence Content
   ⤷ BW-BCT-PLA-RAP (Application Component) Retail Assortment Planning
     ⤷ UPARM (Package) Retail MAP Master Data Maintenance

Properties

Class	CL_UPARM_CUSTOM_EVENT
Short Description	Custom Event Handler Class
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	UPARM	Retail MAP Master Data Maintenance
Created	20081215	SAP
Last change	20141101
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_UPARM_CUSTOM_EVENT has no forward declaration.

Interfaces

Class CL_UPARM_CUSTOM_EVENT has no interface implemented.

Friends

Class CL_UPARM_CUSTOM_EVENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_BADI_CUSTOM_EVENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	BADI_UPARM_CUSTOM_EVENT			20081215
2	MR_CUSTOMIZING	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_UPARM_CUSTOMIZING		Master data maintenance view customizig	20081215
3	MT_CUSTOM_EVENT	Instance attribute	Private	☐	Type reference (TYPE)	UPARM_YT_CUSTOM_EVENT		Custom Event Table	20081215
4	MT_CUSTOM_EVENT_DLG_COMP_INT	Static Attribute	Private	☐	Type reference (TYPE)	CUSTOM_EVENT_DLG_COMP_INT_TTY			20081218
5	MT_CUSTOM_EVENT_INSTANCE	Static Attribute	Private	☐	Type reference (TYPE)	CUSTOM_EVENT_INSTANCE_TTY		Custom Event Handler Class	20090316

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Private	Constructor	Constructor	20081215
2	CUSTOM_EVENT_HANDLER	Instance method	Public	Method	Event handler for custom events	20081215
3	GET_CUSTOM_EVENTS	Instance method	Public	Method	Returns the custom events for a specific location	20081215
4	GET_CUSTOM_EVENT_BY_ID	Instance method	Public	Method	Returns a single custom event	20081222
5	GET_DIALOG_EVENTS	Instance method	Public	Method	Returns all custom events with a WD dialog	20081218
6	GET_FPM_EVENTS	Instance method	Public	Method	Returns FPM custom events	20081216
7	GET_FPM_EVENT_STATE	Instance method	Public	Method	Returns FPM custom event state	20081216
8	GET_INSTANCE	Static method	Public	Method	Returns instance of this class	20081215
9	GET_TABLE_EVENTS	Instance method	Public	Method	Returns table custom events	20081216
10	GET_TABLE_EVENT_STATE	Instance method	Public	Method	Returns table custom event state	20081216
11	GET_WD_COMPONENT_DIALOG	Instance method	Public	Method	Returns the web dynpro component dialog	20081216
12	POPUP_DIALOG	Static method	Public	Method	Popup dialog for custom event	20081215
13	SET_CUSTOM_EVENT_DLG_COMP_INT	Instance method	Public	Method	Sets the custom event component interface for dialogs	20081220

Events

Class CL_UPARM_CUSTOM_EVENT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	CUSTOM_EVENT_DLG_COMP_INT_STY	Public	See coding			20081218	BEGIN OF custom_event_dlg_comp_int_sty, event_id TYPE string, comp_int TYPE REF TO iwci_uparm_wdi_mdp_custom_dlg, END OF custom_event_dlg_comp_int_sty
2	CUSTOM_EVENT_DLG_COMP_INT_TTY	Public	See coding			20081218	custom_event_dlg_comp_int_tty TYPE STANDARD TABLE OF custom_event_dlg_comp_int_sty
3	CUSTOM_EVENT_INSTANCE_STY	Public	See coding			20090316	BEGIN OF custom_event_instance_sty, customizing_key TYPE REF TO cl_uparm_customizing, custom_event_instance TYPE REF TO CL_UPARM_CUSTOM_EVENT, END OF custom_event_instance_sty
4	CUSTOM_EVENT_INSTANCE_TTY	Public	See coding			20090316	custom_event_instance_tty TYPE STANDARD TABLE OF custom_event_instance_sty

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CUSTOMIZING	Call by reference	☐	Object reference (TYPE REF TO)	CL_UPARM_CUSTOMIZING		View ID	20090316

Method CONSTRUCTOR on class CL_UPARM_CUSTOM_EVENT has no exception.

Method CUSTOM_EVENT_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SHOULD_REFRESH	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20081215
2	Importing	IR_MAIN_TABLE_COMP_INT	Call by reference	☑	Object reference (TYPE REF TO)	IWCI_UPARM_WD_MDP_RESULT_TABLE		WebDynpro Interface COMPONENTCONTROLLER	20090122
3	Importing	IR_SECOND_TABLE_COMP_INT	Call by reference	☑	Object reference (TYPE REF TO)	IWCI_UPARM_WD_MDP_RESULT_TABLE		WebDynpro Interface COMPONENTCONTROLLER	20090122
4	Importing	IT_CRITERIA_RANGE	Call by reference	☐	Type reference (TYPE)	RSDRI_T_RANGE		BW Data Manager: Range List	20081215
5	Importing	I_EVENT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20081215

Method CUSTOM_EVENT_HANDLER on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_CUSTOM_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOCATION	Call by reference	☑	Type reference (TYPE)	UPARM_Y_BUTTON_LOCATION		Button Location	20081215
2	Returning	RT_CUSTOM_EVENT	Value transfer	☐	Type reference (TYPE)	UPARM_YT_CUSTOM_EVENT		Custom Event Table	20081215

Method GET_CUSTOM_EVENTS on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_CUSTOM_EVENT_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20081222
2	Returning	RS_CUSTOM_EVENT	Value transfer	☐	Type reference (TYPE)	UPARM_YS_CUSTOM_EVENT		Custom event definition	20081222

Method GET_CUSTOM_EVENT_BY_ID on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_DIALOG_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_CUSTOM_EVENT	Value transfer	☐	Type reference (TYPE)	UPARM_YT_CUSTOM_EVENT		Custom Event Table	20081218

Method GET_DIALOG_EVENTS on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_FPM_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_CUSTOM_EVENT	Value transfer	☐	Type reference (TYPE)	UPARM_YT_CUSTOM_EVENT		Custom Event Table	20081216

Method GET_FPM_EVENTS on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_FPM_EVENT_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CRITERIA_RANGE	Call by reference	☐	Type reference (TYPE)	RSDRI_T_RANGE		BW Data Manager: Range List	20081216
2	Returning	RT_CUSTOM_EVENT_STATE	Value transfer	☐	Type reference (TYPE)	UPARM_YT_CUSTOM_EVENT_STATE		Custom Event State	20081216

Method GET_FPM_EVENT_STATE on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CUSTOMIZING	Call by reference	☐	Object reference (TYPE REF TO)	CL_UPARM_CUSTOMIZING			20090316
2	Returning	RR_CUSTOM_EVENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_UPARM_CUSTOM_EVENT		Custom Event Handler Class	20081215

Method GET_INSTANCE on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_TABLE_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TABLE_TYPE	Call by reference	☐	Type reference (TYPE)	UPARM_Y_RESULT_TABLE_TYPE		Result Table Type (Main or Second Table)	20081216
2	Returning	RT_CUSTOM_EVENT	Value transfer	☐	Type reference (TYPE)	UPARM_YT_CUSTOM_EVENT		Custom Event Table	20081216

Method GET_TABLE_EVENTS on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_TABLE_EVENT_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CRITERIA_RANGE	Call by reference	☐	Type reference (TYPE)	RSDRI_T_RANGE		BW Data Manager: Range List	20081216
2	Importing	I_TABLE_TYPE	Call by reference	☐	Type reference (TYPE)	UPARM_Y_RESULT_TABLE_TYPE		Result Table Type (Main or Second Table)	20081216
3	Returning	RT_CUSTOM_EVENT_STATE	Value transfer	☐	Type reference (TYPE)	UPARM_YT_CUSTOM_EVENT_STATE		Custom Event State	20081216

Method GET_TABLE_EVENT_STATE on class CL_UPARM_CUSTOM_EVENT has no exception.

Method GET_WD_COMPONENT_DIALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20081216
2	Returning	R_WD_COMPONENT_DIALOG	Value transfer	☐	Type reference (TYPE)	UPARM_Y_WD_COMPONENT_DIALOG		MDP Custom WD Component to embed in View	20081216

Method GET_WD_COMPONENT_DIALOG on class CL_UPARM_CUSTOM_EVENT has no exception.

Method POPUP_DIALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_DIALOG_WINDOW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_WINDOW			20081220
2	Importing	IR_COMPONENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT		Web Dynpro: Component	20081220
3	Importing	I_TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20081222
4	Importing	I_WINDOW_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081222

Method POPUP_DIALOG on class CL_UPARM_CUSTOM_EVENT has no exception.

Method SET_CUSTOM_EVENT_DLG_COMP_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CUSTOM_EVENT_DLG_COMP_INT	Call by reference	☐	Type reference (TYPE)	CUSTOM_EVENT_DLG_COMP_INT_TTY			20081220

Method SET_CUSTOM_EVENT_DLG_COMP_INT on class CL_UPARM_CUSTOM_EVENT has no exception.

History

Last changed by/on	SAP	20141101
SAP Release Created in	705