SAP ABAP Class /UI2/CL_USER_PROFILE (UserProfile API for Interoperability)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
     ⤷ /UI2/BASIS_SERVICES_INTEROP (Package) UI BE: Interface Interoperability Service

Properties

Class	/UI2/CL_USER_PROFILE
Short Description	UserProfile API for Interoperability
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/UI2/BASIS_SERVICES_INTEROP	UI BE: Interface Interoperability Service
Created	20140625	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class /UI2/CL_USER_PROFILE has no interface implemented.

Friends

Class /UI2/CL_USER_PROFILE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_KEY_USER_PROF	Constant	Public	☐	Type reference (TYPE)	SPERS_KEY	'/UI2/USER_PROFILE'	Key for PERSREG for API	20140625
2	C_ROLE_FILTER_VALUE	Constant	Public	☐	See coding				20140716
3	GC_DATA_TYPE	Constant	Public	☐	See coding				20140715
4	GC_EDIT_STATE	Constant	Public	☐	See coding				20140715
5	GC_PROPERTY	Constant	Public	☐	See coding				20140715
6	GC_SHELL_TYPE	Constant	Public	☐	See coding				20140714
7	MO_NWBC_RUNTIME	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/UI2/IF_NWBC_RUNTIME		The NWBC Runtime Interface	20140716
8	MT_PROFILES	Static Attribute	Private	☐	Type reference (TYPE)	TP_T_USER_PROFILE			20140711
9	MV_SHELL_TYPE	Instance attribute	Protected	☐	Type reference (TYPE)	STRING			20140715
10	SC_PROFILES_READ	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicator of the read from pers_reg	20140715

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20140711
2	DELETE_USER_PROFILE	Instance method	Public	Method	Retrieves User Profile	20140625
3	GET_MY_INITIAL_PROFILE	Instance method	Protected	Method	Retrieves Own Initial User Profile	20140625
4	GET_NWBC_RUNTIME	Instance method	Protected	Method	Lazy reader for NWBC runtime	20140716
5	GET_USER_PROFILE	Instance method	Public	Method	Retrieves User Profile	20140625
6	READ_PROPERTY	Instance method	Protected	Method	Reads user assigned theme	20140715
7	READ_PROPERTY_THEME	Instance method	Protected	Method	Reads user assigned theme	20140715
8	READ_USER_PROFILE_PERS	Instance method	Protected	Method	Reads personalized user profile	20140715
9	SET_USER_PROFILE	Instance method	Public	Method	Set User Profile	20140625
10	STORE_PROPERTY	Instance method	Protected	Method	Reads user assigned theme	20140715
11	STORE_PROPERTY_ACCESSIBILITY	Instance method	Protected	Method	Stores user assigned theme	20140715

Events

Class /UI2/CL_USER_PROFILE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TP_S_USER_PROFILE	Public	See coding			20140627	BEGIN OF tp_s_user_profile, uname TYPE syuname, id TYPE string, " theme, opacity shell_type TYPE string, " FLP value TYPE string, data_type TYPE string, edit_state TYPE i, validation_mask TYPE string, END OF tp_s_user_profile
2	TP_T_USER_PROFILE	Public	See coding			20140717	tp_t_user_profile TYPE SORTED TABLE OF tp_s_user_profile WITH UNIQUE KEY uname shell_type id
3	TP_T_USER_PROFILE_STD	Public	See coding			20140715	tp_t_user_profile_std TYPE STANDARD TABLE OF tp_s_user_profile WITH KEY uname shell_type id

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NWBC_RUNTIME	Call by reference	☑	Object reference (TYPE REF TO)	/UI2/IF_NWBC_RUNTIME		The NWBC Runtime Interface	20140716
2	Importing	IV_SHELL_TYPE	Call by reference	☑	Type reference (TYPE)	STRING	GC_SHELL_TYPE-FLP	Profile shell type	20140715

Method CONSTRUCTOR on class /UI2/CL_USER_PROFILE has no exception.

Method DELETE_USER_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_USER_PROFILE	Call by reference	☑	Type reference (TYPE)	TP_S_USER_PROFILE			20140715
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		status	20140625

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20140625

Method GET_MY_INITIAL_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_USER_PROFILE	Value transfer	☐	Type reference (TYPE)	/UI2/IF_NWBC_RUNTIME35=>T_USER_INFO		User Profile	20140625

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20140625

Method GET_NWBC_RUNTIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_NWBC_RUNTIME	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_NWBC_RUNTIME		The NWBC Runtime Interface	20140716

Method GET_NWBC_RUNTIME on class /UI2/CL_USER_PROFILE has no exception.

Method GET_USER_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_USER_PROFILE	Call by reference	☐	Type reference (TYPE)	TP_T_USER_PROFILE		User Profiles (if asked for all users)	20140625
2	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	STRING		profile id	20140711

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20140625

Method READ_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_USER_PROFILE	Call by reference	☐	Type reference (TYPE)	TP_T_USER_PROFILE		User profile table to add property	20140715
2	Changing	CT_USER_PROFILE_PERS	Call by reference	☑	Type reference (TYPE)	TP_T_USER_PROFILE		Personalized values for user profile	20140715
3	Importing	IV_DATA_TYPE	Call by reference	☑	Type reference (TYPE)	STRING	GC_DATA_TYPE-STRING	Associated EDM data type	20140715
4	Importing	IV_EDIT_STATE	Call by reference	☑	Type reference (TYPE)	I	GC_EDIT_STATE-OPTIONAL	UI edit state	20140715
5	Importing	IV_MASK	Call by reference	☑	Type reference (TYPE)	STRING		Validation mask for property	20140715
6	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of the property	20140715
7	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Value of the property	20140715

Method READ_PROPERTY on class /UI2/CL_USER_PROFILE has no exception.

Method READ_PROPERTY_THEME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_USER_PROFILE	Call by reference	☐	Type reference (TYPE)	TP_T_USER_PROFILE		User profile table to add property	20140715
2	Changing	CT_USER_PROFILE_PERS	Call by reference	☑	Type reference (TYPE)	TP_T_USER_PROFILE		Personalized values for user profile	20140715

Method READ_PROPERTY_THEME on class /UI2/CL_USER_PROFILE has no exception.

Method READ_USER_PROFILE_PERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_USER_PROFILE	Call by reference	☐	Type reference (TYPE)	TP_T_USER_PROFILE		Personalized profile properties	20140715

Method READ_USER_PROFILE_PERS on class /UI2/CL_USER_PROFILE has no exception.

Method SET_USER_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_USER_PROFILE	Call by reference	☐	Type reference (TYPE)	TP_S_USER_PROFILE			20140625
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20140625

#	Exception	Resumable	Description	Created on
1	/UI2/CX_RUNTIME	☐	UI2 Exception for data provider	20140625

Method STORE_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_USER_PROFILE	Call by reference	☐	Type reference (TYPE)	TP_T_USER_PROFILE		User profile table to read/delete property	20140715
2	Changing	CT_USER_PROFILE_PERS	Call by reference	☑	Type reference (TYPE)	TP_T_USER_PROFILE		Personalized values for user profile	20140715
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of the property	20140715

Method STORE_PROPERTY on class /UI2/CL_USER_PROFILE has no exception.

Method STORE_PROPERTY_ACCESSIBILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_USER_PROFILE	Call by reference	☐	Type reference (TYPE)	TP_T_USER_PROFILE		User profile table to read/delete property	20140715
2	Changing	CT_USER_PROFILE_PERS	Call by reference	☐	Type reference (TYPE)	TP_T_USER_PROFILE		Personalized values for user profile	20140715

Method STORE_PROPERTY_ACCESSIBILITY on class /UI2/CL_USER_PROFILE has no exception.

History

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