SAP ABAP Class CL_WCF_TC_OBJECT (Tag cloud Business object)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-UI (Application Component) User Interface
     ⤷ WCF_TAG_CLOUDS_RT (Package) Tag Clouds Runtime

Properties

Class	CL_WCF_TC_OBJECT
Short Description	Tag cloud Business object
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	WCF_TAG_CLOUDS_RT	Tag Clouds Runtime
Created	20090109	SAP
Last change	20100303	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_WCF_TC_OBJECT has no forward declaration.

Interfaces

Class CL_WCF_TC_OBJECT has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_WCF_TC_FACTORY	☐	20090120	Tag clouds factory
2	CL_WCF_TC_PERSISTENCE	☐	20090120	Persistency class for tag class

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_INVALID_CHARACTERS	Constant	Private	☐	Type reference (TYPE)	STRING	':;.?&[]()#^*@!'		20090115
2	GC_TAG_MAX_LEN	Constant	Private	☐	Type reference (TYPE)	I	255		20090115
3	GT_TAGS	Instance attribute	Private	☐	Type reference (TYPE)	WCF_TCT_OBJECT_TAG		Tags for an object	20090109
4	GT_TAGS_OCCURRENCES	Instance attribute	Private	☐	Type reference (TYPE)	WCF_TCT_TAG_OCCURRENCE		Tags	20090213
5	GV_GENIL_ID	Instance attribute	Private	☐	Type reference (TYPE)	CRMT_GENIL_OBJECT_ID		Object ID in Generic Interaction Layer	20090109
6	GV_ID	Instance attribute	Private	☐	Type reference (TYPE)	WCF_TC_GUID		Unique Id	20090109
7	GV_NAME	Instance attribute	Private	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20090204
8	GV_STATUS	Instance attribute	Private	☐	Type reference (TYPE)	WCF_TC_STATUS		Tag status	20090109
9	GV_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20090109
10	SR_CO	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WCF_TC_CONST		Tag cloud constants	20090113
11	SR_EXCEP	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WCF_TC_EXCEPTION_REPORTER		Services for raising exceptions	20090115
12	SR_PERSIST	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WCF_TC_PERSISTENCE		Persistency class for tag class	20090114
13	SR_SERVICE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WCF_TC_SERVICE		Services method for tag clouds	20090114

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TAG	Instance method	Public	Method	Adds a new tag to object	20090114
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20090113
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090113
4	DELETE_TAG	Instance method	Public	Method	Deletes a tag	20090114
5	DISCARD_CHANGES	Instance method	Public	Method	Rollback any chances made since last save	20090226
6	GET_ALL_TAGS	Instance method	Public	Method	Returns all tags for object	20090114
7	GET_GENIL_ID	Instance method	Public	Method	Returns GENIL id	20090109
8	GET_ID	Instance method	Public	Method	Returns user id	20090109
9	GET_NAME	Instance method	Public	Method	Returns object name	20090204
10	GET_STATUS	Instance method	Public	Method	Returns user status	20090109
11	GET_SUGGESTED_TAGS	Instance method	Public	Method	Returns suggested tags	20090114
12	GET_SUGGESTED_TAGS_FROM_BADI	Instance method	Private	Method		20090114
13	GET_TAGS	Instance method	Public	Method	Returns valid tags for object	20090109
14	GET_TAGS_OCCURRENCES	Instance method	Private	Method	Returns tags occurences	20090114
15	GET_TAGS_USER	Instance method	Public	Method	Returns all tags for a given user	20090114
16	GET_TYPE	Instance method	Public	Method	Returns type	20090109
17	INVALIDATE	Instance method	Private	Method	Invalides occurrences calculation	20090213
18	NOTIFY_ADDITION	Instance method	Private	Method		20090226
19	NOTIFY_DELETION	Instance method	Private	Method		20090226
20	ON_USER_TAGS_DELETED	Instance method	Private	Event handling method	Handles when all tags for a user are deleted	20090309
21	SAVE	Instance method	Public	Method	Saves object and its tags	20090114
22	SET_STATUS	Instance method	Protected	Method	Set object status	20090120

Events

#	Event	Type	Visibility	Description	Created on
1	TAG_ADDED	Instance Event (0)	Public (2)		20090213
2	TAG_DELETED	Instance Event (0)	Public (2)		20090213

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTY_S_TAG_OCCURRENCES	Public	See coding			20090114	BEGIN OF lty_s_tag_occurrences, tag TYPE string, occurrences TYPE i, END OF lty_s_tag_occurrences
2	LTY_S_USER	Public	See coding			20090114	BEGIN OF lty_s_user, username TYPE syuname, END OF lty_s_user
3	LTY_T_TAG_OCCURRENCES	Public	See coding			20090114	lty_t_tag_occurrences TYPE HASHED TABLE OF lty_s_tag_occurrences WITH UNIQUE KEY tag
4	LTY_T_USER	Public	See coding			20090114	lty_t_user TYPE STANDARD TABLE OF lty_s_user

Method Signatures

Method ADD_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENT_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	User Name	20090114
2	Importing	IV_NEW_TAG	Call by reference	☐	Type reference (TYPE)	WCF_TC_TAG_VALUE		Tag value	20090114

#	Exception	Resumable	Description	Created on
1	CX_WCF_TC_DATA_INVALID	☐	new tag is invalid	20090115

Method CLASS_CONSTRUCTOR Signature

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TAGS	Call by reference	☑	Type reference (TYPE)	WCF_TCT_OBJECT_TAG		Tags for object	20090113
2	Importing	IV_GENIL_ID	Call by reference	☐	Type reference (TYPE)	CRMT_GENIL_OBJECT_ID		Object ID in Generic Interaction Layer	20090113
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	WCF_TC_GUID		Unique Id	20090113
4	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20090204
5	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20090113

Method CONSTRUCTOR on class CL_WCF_TC_OBJECT has no exception.

Method DELETE_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENT_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	User Name	20090115
2	Importing	IV_TAG	Call by reference	☐	Type reference (TYPE)	WCF_TC_TAG_VALUE		Tag value	20090114

#	Exception	Resumable	Description	Created on
1	CX_WCF_TC_DATA_NOT_FOUND	☐	Tag not found	20090120

Method DISCARD_CHANGES Signature

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

Method GET_ALL_TAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_TAGS	Value transfer	☐	Type reference (TYPE)	WCF_TCT_OBJECT_TAG		Tags for an object	20090114

Method GET_ALL_TAGS on class CL_WCF_TC_OBJECT has no exception.

Method GET_GENIL_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_GENIL_ID	Value transfer	☐	Type reference (TYPE)	CRMT_GENIL_OBJECT_ID		Object ID in Generic Interaction Layer	20090109

Method GET_GENIL_ID on class CL_WCF_TC_OBJECT has no exception.

Method GET_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_TC_GUID		Unique Id	20090109

Method GET_ID on class CL_WCF_TC_OBJECT has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20090204

Method GET_NAME on class CL_WCF_TC_OBJECT has no exception.

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	WCF_TC_STATUS		User status	20090109

Method GET_STATUS on class CL_WCF_TC_OBJECT has no exception.

Method GET_SUGGESTED_TAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENT_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		User Name	20090114
2	Importing	IV_MAX_TAGS	Call by reference	☐	Type reference (TYPE)	I	5		20090114
3	Returning	RT_TAGS	Value transfer	☐	Type reference (TYPE)	WCF_TCT_OBJECT_TAG		Suggested tags	20090114

Method GET_SUGGESTED_TAGS on class CL_WCF_TC_OBJECT has no exception.

Method GET_SUGGESTED_TAGS_FROM_BADI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENT_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		User Name	20090114
2	Importing	IV_MAX_TAGS	Call by reference	☐	Type reference (TYPE)	I	5		20090114
3	Returning	RT_TAGS	Value transfer	☐	Type reference (TYPE)	WCF_TCT_OBJECT_TAG		Tags for object	20090114

Method GET_SUGGESTED_TAGS_FROM_BADI on class CL_WCF_TC_OBJECT has no exception.

Method GET_TAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_TAGS	Value transfer	☐	Type reference (TYPE)	WCF_TCT_OBJECT_TAG		Tags for an object	20090109

Method GET_TAGS on class CL_WCF_TC_OBJECT has no exception.

Method GET_TAGS_OCCURRENCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_TAGS_OCCURRENCES	Value transfer	☐	Type reference (TYPE)	WCF_TCT_TAG_OCCURRENCE		Tags	20090213

Method GET_TAGS_OCCURRENCES on class CL_WCF_TC_OBJECT has no exception.

Method GET_TAGS_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		User Name	20090114
2	Returning	RT_TAGS	Value transfer	☐	Type reference (TYPE)	WCF_TCT_OBJECT_TAG		Tags for an object	20090114

Method GET_TAGS_USER on class CL_WCF_TC_OBJECT has no exception.

Method GET_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TYPE	Value transfer	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type	20090109

Method GET_TYPE on class CL_WCF_TC_OBJECT has no exception.

Method INVALIDATE Signature

Method INVALIDATE on class CL_WCF_TC_OBJECT has no parameter.
Method INVALIDATE on class CL_WCF_TC_OBJECT has no exception.

Method NOTIFY_ADDITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_TAG	Call by reference	☐	Type reference (TYPE)	WCF_TCS_OBJECT_TAG		Tag for an object	20090226

Method NOTIFY_ADDITION on class CL_WCF_TC_OBJECT has no exception.

Method NOTIFY_DELETION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_TAG	Call by reference	☐	Type reference (TYPE)	WCF_TCS_OBJECT_TAG		Tag for an object	20090226

Method NOTIFY_DELETION on class CL_WCF_TC_OBJECT has no exception.

Method ON_USER_TAGS_DELETED Signature

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

Method ON_USER_TAGS_DELETED on class CL_WCF_TC_OBJECT has no exception.

Method SAVE Signature

Method SAVE on class CL_WCF_TC_OBJECT has no parameter.
Method SAVE on class CL_WCF_TC_OBJECT has no exception.

Method SET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	WCF_TC_STATUS		Status	20090120

Method SET_STATUS on class CL_WCF_TC_OBJECT has no exception.

Event Signatures

Event TAG_ADDED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ES_TAG	Exporting	Value transfer	☐	Type reference (TYPE)	WCF_TCS_TAG		Tag details	20090217

Event TAG_DELETED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ES_TAG	Exporting	Value transfer	☐	Type reference (TYPE)	WCF_TCS_TAG		Tag details	20090217

History

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