SAP ABAP Class CL_MDG_BS_CR_UIBB_EVENTHANDLER (API for dealing with CR UIBB events generically)

Hierarchy

☛ MDG_FND (Software Component) MDG Foundation
   ⤷ CA-MDG-AF (Application Component) Application Framework
     ⤷ USMD_CREQUEST_BOLUI (Package) Change Request BOL UI

Properties

Class	CL_MDG_BS_CR_UIBB_EVENTHANDLER
Short Description	API for dealing with CR UIBB events generically
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	USMD_CREQUEST_BOLUI	Change Request BOL UI
Created	20101123	SAP
Last change	20131127	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

Class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no interface implemented.

Friends

Class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_ACTION_REFRESH	Constant	Public	☐	Type reference (TYPE)	FPM_EVENT_ID	'CR_REFRESH'	ID of the FPM Event	20101123
2	CV_PARAMETER_ACTION_CANCELED	Constant	Public	☐	Type reference (TYPE)	FPM_EVENT_PARAM	'ACTION_CANCELED'	name of the parameter that holds a reference to delta IF	20130429
3	CV_PARAMETER_DELTA_REF	Constant	Public	☐	Type reference (TYPE)	FPM_EVENT_PARAM	'DELTA_REFERENCE'	name of the parameter that holds a reference to delta IF	20101123
4	CV_PARAMETER_HANDLED	Constant	Public	☐	Type reference (TYPE)	FPM_EVENT_PARAM	'ALREADY_HANDLED'	name of the parameter that sets an event to "handled"	20101123
5	CV_PARAMETER_OBJECTS	Constant	Public	☐	Type reference (TYPE)	FPM_EVENT_PARAM	'OBJECT_NAMES'	name of the parameter that holds a reference to delta IF	20101123
6	GO_INSTANCE	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_MDG_BS_CR_UIBB_EVENTHANDLER		API for dealing with MDG search providers	20101123
7	MO_ACCEPTANCE_EVENT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		an event that MUST be triggered by CR UIBB	20101123
8	MO_FPM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_FPM		Interface for accessing FPM functionality	20101123
9	MO_FPM_TOOLBOX	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_BS_FPM_TOOLBOX		Toolbox for FPM enabled applications	20101123
10	MO_MDG_API	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_USMD_CONV_SOM_GOV_API		Governance API: Single Chg. Req. Convenience Governance API	20101123
11	MV_GENIL_COMPONENT	Instance attribute	Public	☑	Type reference (TYPE)	CRMT_COMPONENT_NAME		Name of the component that has foreign relation to CR comp	20101123
12	MV_NEEDS_TO_TRIGGER_SAVE	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110125

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_USMD_MESSAGES	Instance method	Protected	Method	adds USMD typed messages to FPM container	20101123
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20101123
3	EVENT_IS_HANDLED	Instance method	Protected	Method	sets an indicator to classify an event as alread handled	20101123
4	GET_INSTANCE	Static method	Public	Method	returns the singleton reference of the event-handler	20101123
5	IS_EVENT_HANDLED	Instance method	Protected	Method	checks if the event is already handled	20101123
6	NEEDS_TO_TRIGGER_SAVE	Instance method	Public	Method	sets the indicator to trigger a save event when ready	20110125
7	ON_ACCEPTANCE_EVENT	Instance method	Protected	Method	handles events that must pass CR UIBB event handler	20101123
8	ON_CR_CHECK	Instance method	Protected	Method	handles CR check event	20101123
9	ON_CR_REFRESH	Instance method	Protected	Method	handles CR check event	20130429
10	ON_DONE	Instance method	Protected	Method	handles events that return to OVP/main pages	20101123
11	ON_SAVE	Instance method	Protected	Method	handles save event	20110125
12	PROCESS_EVENT	Instance method	Public	Method	handles CR UIBB specific events	20101123
13	SET_GENIL_COMPONENT	Instance method	Public	Method	sets the name of the current main GenIL component	20101123

Events

Class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no event.

Types

Class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no local type.

Method Signatures

Method ADD_USMD_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20101123
2	Importing	IT_USMD_MESSAGES	Call by reference	☐	Type reference (TYPE)	USMD_T_MESSAGE		Messages	20101123

Method ADD_USMD_MESSAGES on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method CONSTRUCTOR Signature

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

Method EVENT_IS_HANDLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20101123

Method EVENT_IS_HANDLED on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME	'CL_MDG_BS_CR_UIBB_EVENTHANDLER'	Abbreviation for Data Collection	20101123
2	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_MDG_BS_CR_UIBB_EVENTHANDLER		API for dealing with CR UIBB events generically	20101123

Method GET_INSTANCE on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method IS_EVENT_HANDLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20101123
2	Returning	RV_ALREADY_HANDLED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		indicator: 'X' = event was already handled	20101123

Method IS_EVENT_HANDLED on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method NEEDS_TO_TRIGGER_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NEEDS_TO_TRIGGER_SAVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		'X' = triggers a save event when ready	20110125

Method NEEDS_TO_TRIGGER_SAVE on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method ON_ACCEPTANCE_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20101123
2	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_RESULT		FPM Event Result	20101123
3	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20101123
4	Importing	IV_RAISED_BY_OWN_UI	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20101123

Method ON_ACCEPTANCE_EVENT on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method ON_CR_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20101123
2	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_RESULT		FPM Event Result	20101123
3	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20101123
4	Importing	IV_RAISED_BY_OWN_UI	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20101123

Method ON_CR_CHECK on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method ON_CR_REFRESH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20130429
2	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_RESULT		FPM Event Result	20130429
3	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20130429
4	Importing	IV_RAISED_BY_OWN_UI	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20130429

Method ON_CR_REFRESH on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method ON_DONE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20101123
2	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_RESULT		FPM Event Result	20101123
3	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20101123
4	Importing	IV_RAISED_BY_OWN_UI	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20101123

Method ON_DONE on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method ON_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20110125
2	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_RESULT		FPM Event Result	20110125
3	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20110125
4	Importing	IV_RAISED_BY_OWN_UI	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110125

Method ON_SAVE on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method PROCESS_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20101123
2	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_RESULT		FPM Event Result	20101123
3	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20101123
4	Importing	IV_RAISED_BY_OWN_UI	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20101123

Method PROCESS_EVENT on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

Method SET_GENIL_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GENIL_COMPONENT_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_COMPONENT_NAME		Component Name	20101123

Method SET_GENIL_COMPONENT on class CL_MDG_BS_CR_UIBB_EVENTHANDLER has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in	703