SAP ABAP Class CL_WCF_FAV_USER_FAVORITES (Favorites for user)
Hierarchy
WEBCUIF (Software Component) SAP Web UI Framework
   CA-WUI-UI (Application Component) User Interface
     WCF_FAVORITES_CORE (Package) Favorites Core Objects
Properties
Class CL_WCF_FAV_USER_FAVORITES  
Short Description Favorites for user    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package WCF_FAVORITES_CORE   Favorites Core Objects 
Created 20090216   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_WCF_FAV_USER_FAVORITES has no forward declaration.
Interfaces
Class CL_WCF_FAV_USER_FAVORITES has no interface implemented.
Friends
Class CL_WCF_FAV_USER_FAVORITES has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GT_FAVORITES Instance attribute Private Type reference (TYPE) WCF_FAVT_FAVORITE Favorites 20090216
2 GT_FOLDERS Instance attribute Private Type reference (TYPE) WCF_FAVT_FOLDER Favorites folders 20090216
3 GV_USER Instance attribute Private Type reference (TYPE) SYUNAME User Name 20090216
4 SR_CO Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_FAV_CONST Favorite constants 20090216
5 SR_EXCEP Static Attribute Private Object reference (TYPE REF TO) CL_WCF_FAV_EXCEPTION_REPORTER Services for raising exceptions 20090219
6 SR_FACTORY Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_FAV_FACTORY Favorites factory 20090217
7 SR_PERSIST Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_FAV_PERSISTENCE Persistence for favorites 20090217
8 SR_SERVICES Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_FAV_SERVICES Service methods for favorites 20090216
Methods
# Method Level Visibility Method type Description Created on
1 ADD_FAVORITE Instance method Public Method Adds a new favorite for user 20090216
2 ADD_FOLDER Instance method Public Method Adds a new folder for user 20090216
3 CLASS_CONSTRUCTOR Static method Public Constructor CLASS_CONSTRUCTOR 20090216
4 COLLAPSE_FOLDER Instance method Public Method Collapses a given folder 20100305
5 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20090216
6 DELETE_FAVORITE Instance method Public Method Deletes an existing favorite 20090216
7 DELETE_FOLDER Instance method Public Method Deletes an existing folder 20090216
8 DISCARD_CHANGES Instance method Public Method Rollback any chances made since last save 20090309
9 DISCARD_FAVORITES_CHANGES Instance method Private Method Rollback any chances made since last save 20090309
10 DISCARD_FOLDERS_CHANGES Instance method Private Method Rollback any chances made since last save 20090309
11 EXPAND_FOLDER Instance method Public Method Expands a given folder 20100305
12 FAVORITE_EXISTS Instance method Private Method Returns true if favorite with same keys exists 20090220
13 FOLDER_EXISTS Instance method Public Method Returns true if folder exists 20090219
14 FOLDER_EXISTS_IN_PARENT Instance method Private Method Returns true if parent folder contains a folder with name 20090220
15 GET_ALL_FAVORITES Instance method Public Method Returns all user favorites 20090218
16 GET_ALL_FOLDERS Instance method Public Method Returns all user folders 20090218
17 GET_FAVORITE Instance method Public Method Returns a specific folder 20090216
18 GET_FAVORITES Instance method Public Method Returns all user favorites 20090216
19 GET_FAVORITE_PARENT_FOLDERS Instance method Private Method Returns all parent folders 20090507
20 GET_FILTERED_FAVORITES Instance method Public Method Returns all user favorites 20090507
21 GET_FILTERED_FOLDERS Instance method Private Method Returns folders for given filtered favorites 20090507
22 GET_FILTERED_HIERARCHY Instance method Public Method Returns both folders and favorites 20090507
23 GET_FOLDER Instance method Public Method Returns a folder information 20090219
24 GET_FOLDERS Instance method Public Method Returns all user folders 20090216
25 GET_FOLDER_BY_NAME Instance method Public Method Returns folder information by name 20090223
26 GET_FOLDER_ELEMENTS Instance method Private Method Returns both folders and favorites in a given folder 20090220
27 GET_FULL_HIERARCHY Instance method Public Method Returns both folders and favorites 20090218
28 GET_NEXT_SEQUENCE Instance method Private Method Returns next sequence available inside a given folder 20090220
29 GET_USER Instance method Public Method Returns user name 20090216
30 LOAD_FAVORITE_REFERENCE Instance method Private Method Loads reference 20090217
31 MOVE_FAVORITE Instance method Public Method Moves given favorite 20090402
32 MOVE_FOLDER Instance method Public Method Moves given folder 20090217
33 ON_FAVORITE_UPDATED Instance method Public Event handling method handles favorite update 20090217
34 RENAME_FAVORITE Instance method Public Method Renames given favorite 20090402
35 RENAME_FOLDER Instance method Public Method Renames given folder 20090217
36 REORDER_LEVEL Instance method Private Method Reorders children after a move 20090219
37 SAVE Instance method Public Method Saves favorites for user 20090217
Events
# Event Type Visibility Description Created on
1 FAVORITE_ADDED Instance Event
(0)
Public
(2)
New favorite added 20090219
2 FAVORITE_DELETED Instance Event
(0)
Public
(2)
Favorite deleted 20090219
Types
Class CL_WCF_FAV_USER_FAVORITES has no local type.
Method Signatures

Method ADD_FAVORITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_FAVORITE Call by reference Object reference (TYPE REF TO) IF_WCF_FAV_FAVORITE_ELEMENT 20090216
2 Importing IV_TYPE Call by reference Type reference (TYPE) WCF_FAV_ELEMENT_TYPE Element type 20090216
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_INVALID Invalid parameters 20090219

Method ADD_FOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) WCF_FAV_NAME New folder name 20090216
2 Importing IV_PARENT Call by reference Type reference (TYPE) WCF_FAV_ID Parent id 20090216
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_INVALID Folder name invalid 20090220

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_WCF_FAV_USER_FAVORITES has no parameter.
Method CLASS_CONSTRUCTOR on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method COLLAPSE_FOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID Folder id 20100305
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_NOT_FOUND Folder not found 20100305

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_FAVORITES Call by reference Type reference (TYPE) WCF_FAVT_FAVORITE Favorites 20090216
2 Importing IT_FOLDERS Call by reference Type reference (TYPE) WCF_FAVT_FOLDER Folders 20090216
3 Importing IV_USER Call by reference Type reference (TYPE) SYUNAME User Name 20090216

Method CONSTRUCTOR on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method DELETE_FAVORITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID Favorite id 20090216

Method DELETE_FAVORITE on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method DELETE_FOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID Favorite id 20090216

Method DELETE_FOLDER on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method DISCARD_CHANGES Signature

Method DISCARD_CHANGES on class CL_WCF_FAV_USER_FAVORITES has no parameter.
Method DISCARD_CHANGES on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method DISCARD_FAVORITES_CHANGES Signature

Method DISCARD_FAVORITES_CHANGES on class CL_WCF_FAV_USER_FAVORITES has no parameter.
Method DISCARD_FAVORITES_CHANGES on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method DISCARD_FOLDERS_CHANGES Signature

Method DISCARD_FOLDERS_CHANGES on class CL_WCF_FAV_USER_FAVORITES has no parameter.
Method DISCARD_FOLDERS_CHANGES on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method EXPAND_FOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID Folder id 20100305
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_NOT_FOUND Folder not found 20100305

Method FAVORITE_EXISTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FOLDER Call by reference Type reference (TYPE) WCF_FAV_ID Folder id 20090220
2 Importing IV_NAME Call by reference Type reference (TYPE) WCF_FAV_NAME Favorite name 20090220
3 Returning RV_EXISTS Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20090220

Method FAVORITE_EXISTS on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method FOLDER_EXISTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FOLDER Call by reference Type reference (TYPE) WCF_FAV_ID ID 20090219
2 Returning RV_EXISTS Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20090219

Method FOLDER_EXISTS on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method FOLDER_EXISTS_IN_PARENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) WCF_FAV_NAME Name 20090220
2 Importing IV_PARENT Call by reference Type reference (TYPE) WCF_FAV_ID Parent folder id 20090220
3 Returning RV_EXISTS Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20090220

Method FOLDER_EXISTS_IN_PARENT on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_ALL_FAVORITES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FAVORITES Value transfer Type reference (TYPE) WCF_FAVT_FAVORITE Favorites 20090218

Method GET_ALL_FAVORITES on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_ALL_FOLDERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FOLDERS Value transfer Type reference (TYPE) WCF_FAVT_FOLDER Folders 20090218

Method GET_ALL_FOLDERS on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_FAVORITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID ID 20090216
2 Returning RR_FAVORITE Value transfer Object reference (TYPE REF TO) IF_WCF_FAV_FAVORITE_ELEMENT 20090216
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_NOT_FOUND Data not found 20090219

Method GET_FAVORITES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FAVORITES Value transfer Type reference (TYPE) WCF_FAVT_FAVORITE Favorites 20090216

Method GET_FAVORITES on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_FAVORITE_PARENT_FOLDERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID ID 20090507
2 Returning RT_PARENT_FOLDERS Value transfer Type reference (TYPE) WCF_FAVT_FOLDER Folders 20090507

Method GET_FAVORITE_PARENT_FOLDERS on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_FILTERED_FAVORITES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_FILTER Call by reference Object reference (TYPE REF TO) IF_WCF_FAV_FILTER Favorite filter 20090507
2 Returning RT_FAVORITES Value transfer Type reference (TYPE) WCF_FAVT_FAVORITE Favorites 20090507

Method GET_FILTERED_FAVORITES on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_FILTERED_FOLDERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_FAVORITES Call by reference Type reference (TYPE) WCF_FAVT_FAVORITE Favorites 20090507
2 Returning RT_FOLDERS Value transfer Type reference (TYPE) WCF_FAVT_FOLDER Folders 20090507

Method GET_FILTERED_FOLDERS on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_FILTERED_HIERARCHY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_FILTER Call by reference Object reference (TYPE REF TO) IF_WCF_FAV_FILTER Favorite filter 20090507
2 Returning RT_HIERARCHY Value transfer Type reference (TYPE) WCF_FAVT_HIERARCHY 20090507

Method GET_FILTERED_HIERARCHY on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_FOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID Folder id 20090219
2 Returning RS_FOLDER Value transfer Type reference (TYPE) WCF_FAVS_FOLDER Folder 20090219
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_NOT_FOUND Folder not found 20090219

Method GET_FOLDERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FOLDERS Value transfer Type reference (TYPE) WCF_FAVT_FOLDER Folders 20090216

Method GET_FOLDERS on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_FOLDER_BY_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) WCF_FAV_NAME Folder name 20090223
2 Importing IV_PARENT Call by reference Type reference (TYPE) WCF_FAV_ID Parent id 20090223
3 Returning RS_FOLDER Value transfer Type reference (TYPE) WCF_FAVS_FOLDER Folder 20090223
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_NOT_FOUND Folder not found 20090223

Method GET_FOLDER_ELEMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FOLDER Call by reference Type reference (TYPE) WCF_FAV_ID Folder id 20090220
2 Returning RT_ELEMENTS Value transfer Type reference (TYPE) WCF_FAVT_HIERARCHY 20090220

Method GET_FOLDER_ELEMENTS on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_FULL_HIERARCHY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_HIERARCHY Value transfer Type reference (TYPE) WCF_FAVT_HIERARCHY 20090218

Method GET_FULL_HIERARCHY on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_NEXT_SEQUENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FOLDER Call by reference Type reference (TYPE) WCF_FAV_ID ID 20090220
2 Returning RV_NEXT_SEQUENCE Value transfer Type reference (TYPE) WCF_FAV_SEQUENCE Sequence id 20090220

Method GET_NEXT_SEQUENCE on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method GET_USER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_USER Value transfer Type reference (TYPE) SYUNAME User Name 20090216

Method GET_USER on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method LOAD_FAVORITE_REFERENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID Favorite id 20090217
# Exception Resumable Description Created on
1 CX_WCF_FAV_OPERATION_FAILED Loading failed 20090219

Method MOVE_FAVORITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID ID 20090402
2 Importing IV_NEW_FOLDER Call by reference Type reference (TYPE) WCF_FAV_ID New parent folder id 20090402
3 Importing IV_NEW_SEQUENCE Call by reference Type reference (TYPE) WCF_FAV_SEQUENCE New sequence id 20090402
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_INVALID Invalid data 20090402

Method MOVE_FOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID Folder id 20090217
2 Importing IV_NEW_PARENT Call by reference Type reference (TYPE) WCF_FAV_ID New parent folder id 20090217
3 Importing IV_NEW_SEQUENCE Call by reference Type reference (TYPE) WCF_FAV_SEQUENCE New sequence id 20090217
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_INVALID Input parameters invalid 20090219

Method ON_FAVORITE_UPDATED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EV_ID Call by reference Attribute reference (LIKE) 20090217

Method ON_FAVORITE_UPDATED on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method RENAME_FAVORITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID ID 20090402
2 Importing IV_NEW_NAME Call by reference Type reference (TYPE) WCF_FAV_NAME Name 20090402
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_INVALID Invalid data 20090402

Method RENAME_FOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_FAV_ID Folder id 20090217
2 Importing IV_NEW_NAME Call by reference Type reference (TYPE) WCF_FAV_NAME New folder name 20090217
# Exception Resumable Description Created on
1 CX_WCF_FAV_DATA_INVALID Input parameters are invalid 20090219

Method REORDER_LEVEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MOVED_ELEMENT Call by reference Type reference (TYPE) WCF_FAV_ID Moved element id 20090219
2 Importing IV_PARENT_FOLDER Call by reference Type reference (TYPE) WCF_FAV_ID Parent folder id 20090219

Method REORDER_LEVEL on class CL_WCF_FAV_USER_FAVORITES has no exception.

Method SAVE Signature

Method SAVE on class CL_WCF_FAV_USER_FAVORITES has no parameter.
# Exception Resumable Description Created on
1 CX_WCF_FAV_OPERATION_FAILED Save failed 20090219
Event Signatures

Event FAVORITE_ADDED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 ES_FAVORITE Exporting Value transfer Type reference (TYPE) WCF_FAVS_FAVORITE Favorite 20090219

Event FAVORITE_DELETED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 EV_ID Exporting Value transfer Type reference (TYPE) WCF_FAV_ID Favorite id 20090219
History
Last changed by/on SAP  20130531 
SAP Release Created in 701