SAP ABAP Class CL_WCF_FAV_SERVICES (Service methods for favorites)

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_SERVICES
Short Description	Service methods for favorites
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	WCF_FAVORITES_CORE	Favorites Core Objects
Created	20090216	SAP
Last change	20100303	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_WCF_FAV_SERVICES has no interface implemented.

Friends

Class CL_WCF_FAV_SERVICES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SR_CO	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_WCF_FAV_CONST		Favorite constants	20090216
2	SR_EXCEP	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WCF_FAV_EXCEPTION_REPORTER		Services for raising exceptions	20090219
3	SR_ME	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_WCF_FAV_SERVICES		Services method for favorite	20090216
4	SR_PERSIST	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_WCF_FAV_PERSISTENCE		Persistence for favorites	20090302

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor	Create the singleton instance	20090216
2	FAVORITE_TYPE_EXISTS	Static method	Public	Method	Returns true if favorite type exists	20090219
3	GET_ALL_UI_OBJECT_TYPES	Static method	Public	Method	Returns all UI Object types of object added to user favs	20090507
4	GET_CURRENT_TIMESTAMP	Static method	Public	Method	Returns current timestamp	20090216
5	GET_FILTER_GENIL_ID	Static method	Public	Method	Returns filter for favorites for a given UI object type	20090508
6	GET_FILTER_OBJECT_ID	Static method	Public	Method	Returns filter for favorites for a given UI object type	20090507
7	GET_FILTER_UI_OBJECT_TYPE	Static method	Public	Method	Returns filter for favorites for a given UI object type	20090507
8	GET_ID_FROM_GENIL_ID	Static method	Public	Method	Returns a guid from a genil id	20090219
9	GET_INSTANCE	Static method	Public	Method	Returns the singleton instance.	20090216
10	GET_MESSAGES	Static method	Public	Method	Builds a message table from the given parameters	20090216
11	GET_NEW_ID	Static method	Public	Method	Creates a new id	20090216
12	GET_UI_OBJTYPE	Static method	Public	Method	Returns the current UI object type	20090601
13	IS_COMMUNITY_ALLOWED	Static method	Public	Method	Returns true if community is allowed	20090312
14	IS_FAVORITES_MODE_ENABLED	Static method	Public	Method	Favorites mode is enabled or not	20090217
15	IS_FAV_ENABLED	Static method	Public	Method	Returns true if favorite are enabled for current context	20090325
16	IS_FAV_ENABLED_FOR_OBJECT_TYPE	Static method	Private	Method	Returns true if favorite feature is active for a given type	20090325
17	IS_FAV_ENABLED_FOR_ROLE	Static method	Public	Method	Returns true if favorites is allowed for a role	20090325
18	IS_SHARING_ALLOWED	Static method	Public	Method	Favorites sharing allowing for a given object type	20090302

Events

Class CL_WCF_FAV_SERVICES has no event.

Types

Class CL_WCF_FAV_SERVICES has no local type.

Method Signatures

Method CLASS_CONSTRUCTOR Signature

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

Method FAVORITE_TYPE_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	WCF_FAV_ELEMENT_TYPE		Element type	20090219
2	Returning	RV_EXISTS	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Type exists	20090219

Method FAVORITE_TYPE_EXISTS on class CL_WCF_FAV_SERVICES has no exception.

Method GET_ALL_UI_OBJECT_TYPES 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_UI_OBJECT_TYPES	Value transfer	☐	Type reference (TYPE)	BSP_DLCT_OBJECT_TYPE		UI Object Types	20090507

Method GET_ALL_UI_OBJECT_TYPES on class CL_WCF_FAV_SERVICES has no exception.

Method GET_CURRENT_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIMESTAMP	Value transfer	☐	Type reference (TYPE)	WCF_FAV_TIMESTAMP		Creation timestamp	20090216

Method GET_CURRENT_TIMESTAMP on class CL_WCF_FAV_SERVICES has no exception.

Method GET_FILTER_GENIL_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GENIL_ID	Call by reference	☐	Type reference (TYPE)	CRMT_GENIL_OBJECT_ID		Object ID in Generic Interaction Layer	20090508
2	Returning	RR_FILTER	Value transfer	☐	Object reference (TYPE REF TO)	IF_WCF_FAV_FILTER		Favorite filter	20090508

Method GET_FILTER_GENIL_ID on class CL_WCF_FAV_SERVICES has no exception.

Method GET_FILTER_OBJECT_ID Signature

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

Method GET_FILTER_OBJECT_ID on class CL_WCF_FAV_SERVICES has no exception.

Method GET_FILTER_UI_OBJECT_TYPE Signature

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

Method GET_FILTER_UI_OBJECT_TYPE on class CL_WCF_FAV_SERVICES has no exception.

Method GET_ID_FROM_GENIL_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GENIL_ID	Call by reference	☐	Type reference (TYPE)	CRMT_GENIL_OBJECT_ID		Object ID in Generic Interaction Layer	20090219
2	Returning	RV_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	WCF_TC_GUID		Object id	20090219

Method GET_ID_FROM_GENIL_ID on class CL_WCF_FAV_SERVICES has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_WCF_FAV_SERVICES		Services method for favorites	20090216

Method GET_INSTANCE on class CL_WCF_FAV_SERVICES has no exception.

Method GET_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MESSAGES	Call by reference	☑	Type reference (TYPE)	WCF_FAVT_MSG		Messages	20090216
2	Importing	IV_MSGID	Call by reference	☑	Type reference (TYPE)	SYMSGID			20090216
3	Importing	IV_MSGNO	Call by reference	☑	Type reference (TYPE)	SYMSGNO			20090216
4	Importing	IV_MSGTY	Call by reference	☑	Type reference (TYPE)	SYMSGTY			20090216
5	Importing	IV_MSGV1	Call by reference	☑	Type reference (TYPE)	ANY			20090216
6	Importing	IV_MSGV2	Call by reference	☑	Type reference (TYPE)	ANY			20090216
7	Importing	IV_MSGV3	Call by reference	☑	Type reference (TYPE)	ANY			20090216
8	Importing	IV_MSGV4	Call by reference	☑	Type reference (TYPE)	ANY			20090216
9	Importing	IV_MSG_PROVIDED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090216
10	Returning	RRT_MESSAGES	Value transfer	☐	Object reference (TYPE REF TO)	WCF_FAVT_MSG		Messages	20090225

Method GET_MESSAGES on class CL_WCF_FAV_SERVICES has no exception.

Method GET_NEW_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ID	Value transfer	☐	Type reference (TYPE)	WCF_FAV_ID		Unique Id	20090216

Method GET_NEW_ID on class CL_WCF_FAV_SERVICES has no exception.

Method GET_UI_OBJTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER		Generic Overview Viewset	20090601
2	Returning	RV_UI_OBJTYPE	Value transfer	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20090601

Method GET_UI_OBJTYPE on class CL_WCF_FAV_SERVICES has no exception.

Method IS_COMMUNITY_ALLOWED Signature

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

Method IS_COMMUNITY_ALLOWED on class CL_WCF_FAV_SERVICES has no exception.

Method IS_FAVORITES_MODE_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENABLED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20090217

Method IS_FAVORITES_MODE_ENABLED on class CL_WCF_FAV_SERVICES has no exception.

Method IS_FAV_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER		UI Object Type	20090601
2	Returning	RV_IS_ENABLED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20090325

Method IS_FAV_ENABLED on class CL_WCF_FAV_SERVICES has no exception.

Method IS_FAV_ENABLED_FOR_OBJECT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_WD_VIEW_CONTROLLER		UI Object Type	20090601
2	Returning	RV_IS_ENABLED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Favorites active for UI Object type	20090325

Method IS_FAV_ENABLED_FOR_OBJECT_TYPE on class CL_WCF_FAV_SERVICES has no exception.

Method IS_FAV_ENABLED_FOR_ROLE Signature

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

Method IS_FAV_ENABLED_FOR_ROLE on class CL_WCF_FAV_SERVICES has no exception.

Method IS_SHARING_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20090302
2	Returning	RV_SHARING_ALLOWED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20090302

Method IS_SHARING_ALLOWED on class CL_WCF_FAV_SERVICES has no exception.

History

Last changed by/on	SAP	20100303
SAP Release Created in	701