SAP ABAP Interface /UI2/IF_WD_PERSONALIZATION (Web Dynpro Personaliization-Interface)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
     ⤷ /UI2/WD_CONFIGURATION (Package) UI2: WD Configuration

Properties

Interface	/UI2/IF_WD_PERSONALIZATION
Short Description	Web Dynpro Personaliization-Interface

General Data

Package	/UI2/WD_CONFIGURATION	UI2: WD Configuration
Created	20130312	SAP
Last changed	20141121
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 /UI2/IF_WD_PERSONALIZATION has no interface.

Friends

Interface /UI2/IF_WD_PERSONALIZATION has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_BTN_APPLY	Constant	Public	☐	Type reference (TYPE)	INT2	2		20130312
2	CO_BTN_CANCEL	Constant	Public	☐	Type reference (TYPE)	INT2	3		20130312
3	CO_BTN_SAVE	Constant	Public	☐	Type reference (TYPE)	INT2	1		20130312
4	CO_PHASE_CANCELLED	Constant	Public	☐	Type reference (TYPE)	NUMC2	'04'		20130312
5	CO_PHASE_DB_ACTION	Constant	Public	☐	Type reference (TYPE)	NUMC2	'03'		20130312
6	CO_PHASE_LOCKED	Constant	Public	☐	Type reference (TYPE)	NUMC2	'01'		20130312
7	CO_PHASE_NONE	Constant	Public	☐	Type reference (TYPE)	NUMC2	'00'		20130312
8	CO_PHASE_UNLOCKED	Constant	Public	☐	Type reference (TYPE)	NUMC2	'02'		20130312
9	CO_SCOPE_ALL	Constant	Public	☐	Type reference (TYPE)	WDR_PERS_SCOPE	4		20130312
10	CO_SCOPE_CONFIG	Constant	Public	☐	Type reference (TYPE)	WDR_PERS_SCOPE	5		20130312
11	CO_SCOPE_CONFIG_BEFORE_ENH	Constant	Public	☐	Type reference (TYPE)	WDR_PERS_SCOPE	255		20130312
12	CO_SCOPE_CONFIG_ENH	Constant	Public	☐	Type reference (TYPE)	WDR_PERS_SCOPE	7		20130312
13	CO_SCOPE_IVIEW	Constant	Public	☐	Type reference (TYPE)	WDR_PERS_SCOPE	2		20130312
14	CO_SCOPE_NONE	Constant	Public	☐	Type reference (TYPE)	WDR_PERS_SCOPE	0		20130312
15	CO_SCOPE_USER	Constant	Public	☐	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DELETE	Instance method	Public	Method		20130312
2	DELETE_NEW	Instance method	Public	Method		20130312
3	ENTER_CHANGE_MODE	Instance method	Public	Method		20130312
4	GET_CONTEXT_CHANGE_ASSISTANT	Instance method	Public	Method		20130312
5	GET_DEFAULT_VARIANT	Instance method	Public	Method		20130312
6	GET_STATE	Instance method	Public	Method		20130312
7	GET_TABLE_INTERFACE	Instance method	Public	Method		20130312
8	GET_TABLE_READER	Instance method	Public	Method		20130312
9	GET_VALID_PERS_SCOPE	Instance method	Public	Method		20130312
10	GET_VARIANTS	Instance method	Public	Method		20130312
11	GET_VARIANTS_FOR_SUBCOMPONENT	Instance method	Public	Method		20130312
12	IS_ADAPTATION_ALLOWED	Instance method	Public	Method		20130312
13	IS_IMPLEMENTATION_SUPPLIED	Instance method	Public	Method		20130312
14	IS_TABLE_READER_SUPPORTED	Instance method	Public	Method		20130312
15	LEAVE_CHANGE_MODE	Instance method	Public	Method		20130312
16	LOAD_CONFIG_BY_KEY	Instance method	Public	Method		20130312
17	RESTRICT_IMPL_PERS	Instance method	Public	Method		20130312
18	SAVE	Instance method	Public	Method		20130312
19	SAVE_NEW	Instance method	Public	Method		20130312
20	SAVE_NEW_VARIANT	Instance method	Public	Method		20130312
21	SAVE_NEW_VARIANT_NEW	Instance method	Public	Method		20130312
22	SET_CHANGE_MODE	Instance method	Public	Method		20130312
23	SET_CONFIG_KEY	Instance method	Public	Method		20130312
24	SET_DEFAULT_VARIANT	Instance method	Public	Method		20130312
25	SUPPORT_DELTA_HANDLING	Instance method	Public	Method		20130312
26	TRANSPORT_ALLOWED	Instance method	Public	Method		20130312
27	UNDO_CONTEXT_CHANGES	Instance method	Public	Method		20130312
28	UPDATE_IMPL_PERS	Instance method	Public	Method		20130312

Events

#	Event	Type	Visibility	Description	Created on
1	PERSONALIZATION_CALLBACK	Instance Event (0)	Public (2)		20130312

Types

Interface /UI2/IF_WD_PERSONALIZATION has no local type.

Method Signatures

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONFIG_KEY	Value transfer	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
2	Importing	SCOPE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312
3	Returning	SUCCESS	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN			20130312
4	Importing	TRANSPORT_PERSONALIZATION	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN			20130312
5	Importing	TRKORR	Call by reference	☑	Type reference (TYPE)	TRKORR			20130312

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐		20130312

Method DELETE_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONFIG_KEY	Value transfer	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
2	Importing	SCOPE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312

Method DELETE_NEW on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method ENTER_CHANGE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEVCLASS	Call by reference	☑	Type reference (TYPE)	DEVCLASS			20130312
2	Importing	PERS_SCOPE	Value transfer	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312
3	Importing	TRANSPORT	Call by reference	☑	Type reference (TYPE)	TRKEY			20130312
4	Importing	TRANSPORT_PERSONALIZATION	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN			20130312
5	Changing	TRKORR	Call by reference	☑	Type reference (TYPE)	TRKORR			20130312

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐		20130312

Method GET_CONTEXT_CHANGE_ASSISTANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CONTEXT_ASSISTANT	Value transfer	☐	Object reference (TYPE REF TO)	IF_WD_CONFIG_CONTEXT			20130312

Method GET_CONTEXT_CHANGE_ASSISTANT on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method GET_DEFAULT_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	SCOPE	Call by reference	☐	Type reference (TYPE)	WDR_PERS_SCOPE			20130312
2	Exporting	VARIANT	Call by reference	☐	Type reference (TYPE)	WDR_PERS_VARIANT			20130312

Method GET_DEFAULT_VARIANT on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
2	Exporting	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	WDY_MD_DESCRIPTION			20130312
3	Exporting	DEVCLASS	Call by reference	☐	Type reference (TYPE)	DEVCLASS			20130312
4	Exporting	IS_LOADED	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN			20130312
5	Exporting	LAST_TRANSPORT	Call by reference	☐	Type reference (TYPE)	TRKORR			20130312
6	Exporting	LOADED_SCOPE	Call by reference	☐	Type reference (TYPE)	WDR_PERS_SCOPE			20130312
7	Exporting	ORIGINAL_CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
8	Exporting	PERS_SCOPE	Call by reference	☐	Type reference (TYPE)	WDR_PERS_SCOPE			20130312

Method GET_STATE on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method GET_TABLE_INTERFACE Signature

Method GET_TABLE_INTERFACE on Interface /UI2/IF_WD_PERSONALIZATION has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐		20130312

Method GET_TABLE_READER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FOR_BASE	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
2	Returning	R_TABLE_READER	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_WD_PERS_TABLE_READER			20130312

Method GET_TABLE_READER on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method GET_VALID_PERS_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_SCOPE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312
2	Returning	SCOPE	Value transfer	☐	Type reference (TYPE)	WDR_PERS_SCOPE			20130312

Method GET_VALID_PERS_SCOPE on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method GET_VARIANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ONLY_PERS_VARIANTS	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
2	Returning	VARIANTS	Value transfer	☐	Type reference (TYPE)	WDR_PERS_VARIANTS			20130312

Method GET_VARIANTS on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method GET_VARIANTS_FOR_SUBCOMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONFIG_KEY	Call by reference	☑	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
2	Importing	ONLY_PERS_VARIANTS	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
3	Importing	SUBCOMPONENT_USAGE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20130312
4	Returning	VARIANTS	Value transfer	☐	Type reference (TYPE)	WDR_PERS_VARIANTS			20130312

Method GET_VARIANTS_FOR_SUBCOMPONENT on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method IS_ADAPTATION_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_PERS_ALLOWED	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN			20130312

Method IS_ADAPTATION_ALLOWED on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method IS_IMPLEMENTATION_SUPPLIED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_SUPPLIED	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN			20130312
2	Importing	SUBCOMPONENT_USAGE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20130312

Method IS_IMPLEMENTATION_SUPPLIED on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method IS_TABLE_READER_SUPPORTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TABLE_READER_IS_SUPPORTED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130312

Method IS_TABLE_READER_SUPPORTED on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method LEAVE_CHANGE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PERS_SCOPE	Value transfer	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐		20130312

Method LOAD_CONFIG_BY_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
2	Exporting	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20130312
3	Importing	FETCH_DEFAULT_VARIANT	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
4	Exporting	SCOPE	Value transfer	☐	Type reference (TYPE)	WDR_PERS_SCOPE			20130312

Method LOAD_CONFIG_BY_KEY on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method RESTRICT_IMPL_PERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXCEPTION_TABLE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_EXCEPTION_TABLE			20130312
2	Importing	RESTRICTED	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_TRUE		20130312

Method RESTRICT_IMPL_PERS on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ACTUAL_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20130312
2	Importing	DEFAULT_VARIANT	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
3	Importing	DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20130312
4	Importing	DEVCLASS	Call by reference	☑	Type reference (TYPE)	DEVCLASS	'$TMP'		20130312
5	Importing	PERS_SCOPE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312
6	Importing	TRANSPORT	Call by reference	☑	Type reference (TYPE)	TRKEY			20130312
7	Importing	TRANSPORT_PERSONALIZATION	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
8	Importing	TRKORR	Call by reference	☑	Type reference (TYPE)	TRKORR			20130312

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐		20130312

Method SAVE_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT_VARIANT	Value transfer	☑	Type reference (TYPE)	WDY_BOOLEAN			20130312
2	Importing	DESCRIPTION	Value transfer	☑	Type reference (TYPE)	STRING			20130312
3	Importing	PERS_SCOPE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312

Method SAVE_NEW on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method SAVE_NEW_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ACTUAL_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20130312
2	Importing	DEFAULT_VARIANT	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
3	Importing	DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20130312
4	Importing	DEVCLASS	Call by reference	☑	Type reference (TYPE)	DEVCLASS	'$TMP'		20130312
5	Importing	PERS_SCOPE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312
6	Importing	TRANSPORT	Call by reference	☑	Type reference (TYPE)	TRKEY			20130312
7	Importing	TRANSPORT_PERSONALIZATION	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
8	Importing	TRKORR	Call by reference	☑	Type reference (TYPE)	TRKORR			20130312

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐		20130312

Method SAVE_NEW_VARIANT_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT_VARIANT	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130312
2	Importing	DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20130312
3	Importing	PERS_SCOPE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐		20130312

Method SET_CHANGE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHANGE_MODE	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	'X'		20130312
2	Importing	PERS_SCOPE	Value transfer	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312

Method SET_CHANGE_MODE on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method SET_CONFIG_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
2	Importing	DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20130312

Method SET_CONFIG_KEY on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method SET_DEFAULT_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
2	Importing	SCOPE	Call by reference	☑	Type reference (TYPE)	WDR_PERS_SCOPE	1		20130312
3	Importing	SET	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN	ABAP_TRUE		20130312

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐		20130312

Method SUPPORT_DELTA_HANDLING Signature

Method SUPPORT_DELTA_HANDLING on Interface /UI2/IF_WD_PERSONALIZATION has no parameter.
Method SUPPORT_DELTA_HANDLING on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method TRANSPORT_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ALLOWED	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN			20130312

Method TRANSPORT_ALLOWED on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method UNDO_CONTEXT_CHANGES Signature

Method UNDO_CONTEXT_CHANGES on Interface /UI2/IF_WD_PERSONALIZATION has no parameter.
Method UNDO_CONTEXT_CHANGES on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Method UPDATE_IMPL_PERS Signature

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

Method UPDATE_IMPL_PERS on Interface /UI2/IF_WD_PERSONALIZATION has no exception.

Event Signatures

Event PERSONALIZATION_CALLBACK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	CONFIG_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20130312
2	HAS_ERRORS	Exporting	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN			20130312
3	MESSAGES	Exporting	Value transfer	☐	Type reference (TYPE)	CTS_MESSAGES			20130312
4	PHASE_INDICATOR	Exporting	Value transfer	☐	Type reference (TYPE)	NUMC2			20130312

History

Last changed by/on	SAP	20141121
SAP Release Created in	100