SAP ABAP Class CL_UC_COMMENT (General Comments SEM-BCS for AFD and Documents)

Hierarchy

☛ SEM-BW (Software Component) SEM-BW: Strategic Enterprise Management
   ⤷ FIN-SEM-BCS-INT (Application Component) Data Collection
     ⤷ UCC2 (Package) SEM-BCS: Comments - Transaction Data

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_UC_COMMENT	Access to SEM-BCS Comments	20031114

Properties

Class	CL_UC_COMMENT
Short Description	General Comments SEM-BCS for AFD and Documents
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	UCC2
Program status	P	SAP Standard Production Program
Category	0
Package	UCC2	SEM-BCS: Comments - Transaction Data
Created	20031114	SAP
Last change	20041006	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SKWFC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	UC00	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_UC_COMMENT	☐	☐	Access to SEM-BCS Comments	20031114

Friends

Class CL_UC_COMMENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_ACTION_INSERT	Constant	Public	☐	Type reference (TYPE)	CHAR1	'I'	Insert Comment	20031218
2	C_ACTION_UPDATE	Constant	Public	☐	Type reference (TYPE)	CHAR1	'U'	Single-Character Indicator	20031218
3	C_DOCTYPE_TEXT	Static Attribute	Public	☑	Type reference (TYPE)	CHAR40	'text/plain'	Text Document	20031217
4	DO_AREA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_UC_AREA		Pointer to Cons Area	20031121
5	DO_DATABASIS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_UC_DATABASIS		Pointer to Data Basis	20031121
6	D_RFCDEST	Instance attribute	Private	☐	Type reference (TYPE)	RFCDEST		RFC Destination of Data Basis	20031121
7	GR_MODEL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_UC_MODEL		Pointer to Model	20031114
8	GT_COMMENT	Instance attribute	Private	☐	Type reference (TYPE)	UCC0_T_COMMENT		Lookup Table of Comments	20031217
9	GT_INSTANCE_DIR	Static Attribute	Private	☐	Type reference (TYPE)	UCC2_T_COMM_DIR		Instance Directory	20031121
10	GT_MAPPING	Instance attribute	Private	☐	Type reference (TYPE)	UCC2_T_MAPPING		Table Field Name<->BW Name	20031114
11	G_DOCID	Instance attribute	Private	☐	Type reference (TYPE)	I		Global Counter for Comments	20031218
12	MR_OBJECT	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_UC_COMMENT		General Comments SEM-BCS	20031121
13	M_AREA	Static Attribute	Private	☐	Type reference (TYPE)	UC_AREA		Consolidation Area	20031121
14	M_TYPE	Static Attribute	Private	☐	Type reference (TYPE)	CHAR2		Component of Version Number	20031121

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Instance Generation per Cons Area	20031114
2	CONVERT_HASH_TO_INITIAL	Instance method	Private	Method	Converts #Characteristic Value into Type-Related Init. Value	20040126
3	CONVERT_INITIAL_TO_HASH	Instance method	Private	Method	Converts Type-Related Init. Value after #	20040126
4	CONVERT_SEL_TO_TABLE	Instance method	Private	Method	Converts Selection Object in KW Query Table	20031121
5	GET_COMMENT_ATTRIBUTES	Instance method	Private	Method	Extract Comment Properties from PHIOs	20031209
6	GET_INSTANCE	Static method	Public	Method	Return Pointer to Comment Interface	20031121
7	GET_PROPVAL_FOR_COMMENT	Instance method	Private	Method	Reads Property Value from Comment Structure	20040109
8	SET_ALL_PROPVAL_FOR_COMMENT	Instance method	Private	Method	Replaces All Property Values in Comment Structure	20040129
9	SET_PROPVAL_FOR_COMMENT	Instance method	Private	Method	Writes Property Value in Comment Structure	20040109
10	TRANSFORM_FIELD_TO_KW	Instance method	Private	Method	Field Transformation BCS Selection to KW Selection	20031121

Events

Class CL_UC_COMMENT has no event.

Types

Class CL_UC_COMMENT has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_MODEL		Modell (Metadaten)	20040113
2	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	UC_AREA		Konsolidierungsgebiet	20031114
3	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	UC_COMMENT_TYPE		Type des Kommentares	20031114

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Instanzerzeugung fehlgeschlagen	20031114

Method CONVERT_HASH_TO_INITIAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANM	Call by reference	☐	Type reference (TYPE)	UC_FIELDNAME		Feldname	20040126
2	Changing	X_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Merkmalswert	20040126

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Konvertierung gescheitert	20040126

Method CONVERT_INITIAL_TO_HASH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANM	Call by reference	☐	Type reference (TYPE)	UC_FIELDNAME		Feldname	20040126
2	Changing	X_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Merkmalswert	20040126

#	Exception	Resumable	Description	Created on
1	FAILED	☐		20040126

Method CONVERT_SEL_TO_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY	Call by reference	☐	Type reference (TYPE)	UCC0_T_COMMQUERY		Tabelle einer Kommentarselektion zur Query im KW	20031121
2	Importing	IR_SEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_SEL		Interface Selektionsbedingung	20031121

#	Exception	Resumable	Description	Created on
1	SELECTION_INVALID	☐	Ungueltige Selektion	20031121

Method GET_COMMENT_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_LOIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20031209
2	Exporting	ES_PHIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20031209
3	Importing	I_OBJID	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID		ID für Dokumente und Beziehungen	20031209
4	Changing	XS_COMMENT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	UCC0_S_COMMENT_ATTRIBUT		Attribute eines Kommentares	20031209

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20031209
2	RFC_ERROR	☐	RFC-Fehler	20031209

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_COMMENT		Zugriff auf SEM-BCS Kommentare	20031121
2	Importing	IR_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_MODEL		Modell (Metadaten)	20040113
3	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	UC_COMMENT_TYPE		Komponente der Versionsnummer	20031121

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Allgemeiner Fehler	20031121
2	NO_TYPE	☐	Kein Kommentartyp angegeben	20031121

Method GET_PROPVAL_FOR_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_VALUE	Call by reference	☐	Type reference (TYPE)	UC0_T_VALUE		Feldwerte	20040109
2	Importing	IS_COMMENT_LIST	Call by reference	☐	Type reference (TYPE)	UCC0_S_COMMENT_ATTRIBUT		Attribute eines Kommentares	20040109
3	Importing	I_PROPNAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Feldname	20040109

#	Exception	Resumable	Description	Created on
1	FAILED	☐	allgemeiner Fehler	20040109
2	NOTHING_FOUND	☐	Nicht gefunden	20040109

Method SET_ALL_PROPVAL_FOR_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_VALUE	Call by reference	☐	Type reference (TYPE)	UC0_T_VALUE		Tabelle der Feldwerte	20040129
2	Importing	I_PROPNAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Feldname	20040129
3	Changing	XS_COMMENT_LIST	Call by reference	☐	Type reference (TYPE)	UCC0_S_COMMENT_ATTRIBUT		Attribute eines Kommentares	20040129

#	Exception	Resumable	Description	Created on
1	FAILED	☐	allgemeiner Fehler	20040129
2	NOTHING_FOUND	☐	Nicht gefunden	20040129

Method SET_PROPVAL_FOR_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROPNAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Feldname	20040109
2	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	UC_VALUE		Feldwerte	20040109
3	Changing	XS_COMMENT_LIST	Call by reference	☐	Type reference (TYPE)	UCC0_S_COMMENT_ATTRIBUT		Attribute eines Kommentares	20040109

#	Exception	Resumable	Description	Created on
1	FAILED	☐	allgemeiner Fehler	20040109
2	NOTHING_FOUND	☐	Nicht gefunden	20040109

Method TRANSFORM_FIELD_TO_KW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY	Call by reference	☐	Type reference (TYPE)	UCC0_T_COMMQUERY		Tabelle einer Kommentarselektion zur Query im KW	20031121
2	Importing	IT_VALUE	Call by reference	☐	Type reference (TYPE)	UC0_TS_SEL		Feldwerte	20031121

#	Exception	Resumable	Description	Created on
1	TABLE_EMPTY	☐	Keine Transformation möglich	20031121

History

Last changed by/on	SAP	20041006
SAP Release Created in	400