SAP ABAP Class /UI2/IF_FAV_DATA (Favorites data management)
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  /UI2/CL_FAV_DATA Favorite data manager 20120404
Properties
Class /UI2/IF_FAV_DATA  
Short Description Favorites data management    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package      
Created 20120404   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 /UI2/IF_FAV_DATA has no interface implemented.
Friends
Class /UI2/IF_FAV_DATA has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 C_PERS_KEY_FAV Constant Public Type reference (TYPE) SPERS_KEY '/UI2/FAV_DATA' Personalization data key 20120405
2 C_TYPE_LPD_AL Constant Public Type reference (TYPE) STRING 'LPD_AL' Item Type for LPD with alias 20120410
3 C_TYPE_LPD_ID Constant Public Type reference (TYPE) STRING 'LPD_ID' Item Type for LPD with application ID 20120410
4 C_TYPE_PFCG_AL Constant Public Type reference (TYPE) STRING 'PFCG_AL' Item Type for PFCG with alias 20120410
5 C_TYPE_PFCG_ID Constant Public Type reference (TYPE) STRING 'PFCG_ID' Item Type for PFCG with application ID 20120410
6 C_TYPE_US_FAVORITES Constant Public Type reference (TYPE) STRING 'US_FAVORITES' Item Type for Unified Shell Favorites with data key 20130514
Methods
# Method Level Visibility Method type Description Created on
1 DELETE_ITEMS Instance method Public Method Delete favorite items 20120405
2 GET_ITEMS Instance method Public Method Exports favorite items filtered by type 20120404
3 MARK_AS_FAVORITE Instance method Public Method Marks item as favorite 20120404
4 SET_ITEMS Instance method Public Method Adds/updates favorite items 20120404
5 UPDATE_USAGE Instance method Public Method Update favorite usage counter 20120404
Events
Class /UI2/IF_FAV_DATA has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TP_S_FAVORITE Public See coding 20120405 BEGIN OF tp_s_favorite, type TYPE string, repository TYPE string, object TYPE string, created TYPE timestamp, last_used TYPE timestamp, usage_counter TYPE i, favorite TYPE abap_bool, END OF tp_s_favorite
2 TP_S_FAV_CACHE Public See coding 20121207 BEGIN OF tp_s_fav_cache, type TYPE string, repository TYPE string, object TYPE ref to /ui2/cl_fav_cache, END OF tp_s_fav_cache
3 TP_T_FAVORITES Public See coding 20120405 tp_t_favorites TYPE SORTED TABLE OF tp_s_favorite WITH UNIQUE KEY type repository object
4 TP_T_FAV_CACHE Public See coding 20121207 tp_t_fav_cache TYPE SORTED TABLE OF tp_s_fav_cache WITH UNIQUE KEY type repository object
Method Signatures

Method DELETE_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OBJECT Call by reference Type reference (TYPE) STRING Object id 20120405
2 Importing IV_REPOSITORY Call by reference Type reference (TYPE) STRING Favorites repository filter 20120405
3 Importing IV_TYPE Call by reference Type reference (TYPE) STRING Favorites type filter 20120405
# Exception Resumable Description Created on
1 /UI2/CX_RUNTIME UI2 Exception for data provider 20120410

Method GET_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ITEMS Call by reference Type reference (TYPE) TP_T_FAVORITES 20120404
2 Importing IV_FAVORITE Call by reference Type reference (TYPE) ABAP_BOOL Favorite state filter 20120404
3 Importing IV_REPOSITORY Call by reference Type reference (TYPE) STRING Favorites repository filter 20120404
4 Importing IV_TYPE Call by reference Type reference (TYPE) STRING Favorites type filter 20120404

Method GET_ITEMS on class /UI2/IF_FAV_DATA has no exception.

Method MARK_AS_FAVORITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ENSURE_EXIST Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Create item if not exist 20120405
2 Importing IV_FAVORITE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Favorite state 20120404
3 Importing IV_OBJECT Call by reference Type reference (TYPE) STRING Object id within repository 20120404
4 Importing IV_REPOSITORY Call by reference Type reference (TYPE) STRING Repository id of the object 20120404
5 Importing IV_TYPE Call by reference Type reference (TYPE) STRING Type of the object 20120404
# Exception Resumable Description Created on
1 /UI2/CX_RUNTIME UI2 Exception for data provider 20120410

Method SET_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ITEMS Call by reference Type reference (TYPE) TP_T_FAVORITES Items to be updated/created 20120404
2 Importing IV_REPLACE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Replace existing items with provided 20120405
# Exception Resumable Description Created on
1 /UI2/CX_RUNTIME UI2 Exception for data provider 20120410

Method UPDATE_USAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ENSURE_EXIST Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Create item if not exist 20120405
2 Importing IV_OBJECT Call by reference Type reference (TYPE) STRING Object id within repository 20120404
3 Importing IV_REPOSITORY Call by reference Type reference (TYPE) STRING Repository id of the object 20120404
4 Importing IV_TYPE Call by reference Type reference (TYPE) STRING Type of the object 20120404
# Exception Resumable Description Created on
1 /UI2/CX_RUNTIME UI2 Exception for data provider 20120410
History
Last changed by/on SAP  20131127 
SAP Release Created in