SAP ABAP Class CL_UC_COMMENT_DATA (Data Class of SEM-BCS Comment)

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_APPLICATION	Comment hosting application	20040116
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_UC_CUST_DATA	Internal View of Customizing Data	20031126
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_UC_CUST_DATA_EXT	External view at Customizing data	20031126

Properties

Class	CL_UC_COMMENT_DATA
Short Description	Data Class of SEM-BCS Comment
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

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

Forward declarations

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

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_UC_COMMENT_APPLICATION	☐	☐	Comment hosting application	20040116
2	IF_UC_CUST_DATA	☐	☐	Internal View of Customizing Data	20031126
3	IF_UC_CUST_DATA_EXT	☐	☐	External view at Customizing data	20031126

Friends

Class CL_UC_COMMENT_DATA has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DD_ACTION	Instance attribute	Private	☐	Type reference (TYPE)	CHAR2		Value of one of the GC_ACTION_ constants	20031204
2	DD_LAYOUT_MODE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		'V': vertical layout, 'H': horizontal layout	20031204
3	DF_BUFFER_CHANGED	Instance attribute	Private	☐	Type reference (TYPE)	UC_FLG			20040114
4	DF_COMMENT_SAVED	Instance attribute	Private	☐	Type reference (TYPE)	UC_FLG		General Indicator, SAP Consolidation	20031222
5	DO_APPL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_UC_COMMENT_APPLICATION		Comment hosting application	20040108
6	DO_COMMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_UC_COMMENT		Access to SEM-BCS Comments	20031126
7	DO_MODEL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_UC_MODEL			20031215
8	DO_SEL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_UC_SEL		Interface Selection Condition	20031219
9	DS_COMMENT_ATTRIBUTE	Instance attribute	Private	☐	Type reference (TYPE)	UCC0_S_COMMENT_ATTRIBUT			20031217
10	DS_COMMENT_LIST	Instance attribute	Private	☐	Type reference (TYPE)	UCC0_S_COMMENT_ATTRIBUT		Attributes of a Comment	20031127
11	DT_BUFFER_CONTENT	Instance attribute	Private	☐	Type reference (TYPE)	T_BUFFER_CONTENT			20040115
12	DT_CHAVL	Instance attribute	Private	☐	Type reference (TYPE)	UC0_T_VALUE			20040107
13	DT_COMMENT_ASC	Instance attribute	Private	☐	Type reference (TYPE)	UCC0_T_ASCII_CONTENT		Common content in Ascii format	20040113
14	DT_COMMENT_BIN	Instance attribute	Private	☐	Type reference (TYPE)	UCC0_T_CONTENT		Common content in bin format	20040113
15	DT_COMMENT_LIST	Instance attribute	Private	☐	Type reference (TYPE)	UCC0_T_COMMENT_ATTRIBUT		Directory of comments (only Header Info)	20031127
16	DT_LOCKED_COMMENT	Instance attribute	Private	☐	Type reference (TYPE)	T_LOCKED_COMMENT			20040204
17	GC_ACTION_CHANGE	Constant	Public	☐	Type reference (TYPE)	CHAR2	'03'	Component of Version Number	20031204
18	GC_ACTION_CREATE	Constant	Public	☐	Type reference (TYPE)	CHAR2	'01'	Component of Version Number	20031204
19	GC_ACTION_DELETE	Constant	Public	☐	Type reference (TYPE)	CHAR2	'04'	Component of Version Number	20031204
20	GC_ACTION_DISPLAY	Constant	Public	☐	Type reference (TYPE)	CHAR2	'02'	Component of Version Number	20031204
21	GC_ACTION_IMPORT	Constant	Public	☐	Type reference (TYPE)	CHAR2	'05'		20031229
22	GC_CLASSNAME_GUI	Constant	Private	☐	Type reference (TYPE)	CLASSNAME	'CL_UC_COMMENT_GUI'	Reference Type	20031126
23	GC_LAYOUT_MODE_HOR	Constant	Public	☐	Type reference (TYPE)	CHAR1	'H'	horizontal layout mode	20040114
24	GC_LAYOUT_MODE_VER	Constant	Public	☐	Type reference (TYPE)	CHAR1	'V'	Vertical layout mode	20040114
25	GO_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_UC_COMMENT_DATA		Data class of comment	20031126

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_COMMENT_CONTENT	Instance method	Public	Method	To get a comment's content	20031127
2	GET_COMMENT_MODEL	Instance method	Public	Method	To get model	20031215
3	GET_GUI_DATA	Instance method	Public	Method	GUI class can get all data needed by using this class	20031204
4	GET_GUI_LAYOUTMODE	Instance method	Public	Method		20040401
5	GET_INSTANCE	Static method	Public	Method	To get an instance of the comment data class	20031126
6	INIT	Instance method	Private	Method	To initialize the instance and get the list of the comments	20031126
7	SAVE_ONE_COMMENT	Instance method	Private	Method	To save one comment from the buffer table	20040113
8	SET_GUI_DATA	Instance method	Public	Method	GUI class can set all data by using this class	20031204
9	UNLOAD_DATA	Instance method	Public	Method	To unload the data class and related instances	20031230

Events

Class CL_UC_COMMENT_DATA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_BUFFER_CONTENT	Public	See coding			20040117	begin of S_BUFFER_CONTENT, GUI_ACTION(2) type C, COMMENT_ATTR type UCC0_S_COMMENT_ATTRIBUT, CONTENT_BIN type UCC0_T_CONTENT, CONTENT_ASC type UCC0_T_ASCII_CONTENT, end of S_BUFFER_CONTENT
2	S_LOCKED_COMMENT	Public	See coding			20040204	begin of S_LOCKED_COMMENT, DOCID type UCC0_Y_DOCID, LOCK_STATE type CHAR1, end of S_LOCKED_COMMENT
3	T_BUFFER_CONTENT	Public	See coding			20040117	T_BUFFER_CONTENT type standard table of S_BUFFER_CONTENT
4	T_LOCKED_COMMENT	Public	See coding			20040204	T_LOCKED_COMMENT type standard table of S_LOCKED_COMMENT

Method Signatures

Method GET_COMMENT_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMMENT_ASC	Call by reference	☐	Type reference (TYPE)	UCC0_T_ASCII_CONTENT		ASCII-Tabelle	20031127
2	Exporting	ET_COMMENT_BIN	Call by reference	☐	Type reference (TYPE)	UCC0_T_CONTENT		Inhalt eines Dokuments Binär	20031127
3	Importing	IS_COMMENT_ATTR	Call by reference	☐	Type reference (TYPE)	UCC0_S_COMMENT_ATTRIBUT			20040113
4	Importing	I_DOCID	Call by reference	☑	Type reference (TYPE)	UCC0_Y_DOCID		ID zum aktuellen Dokument	20031127
5	Importing	I_ENQMODE	Call by reference	☐	Type reference (TYPE)	CHAR1			20031203

#	Exception	Resumable	Description	Created on
1	EMPTY_FILES	☐	Kein gefülltes Contentfile unter ID gefunden	20031127
2	FOREIGN_LOCK	☐	Indicates that the comment is locked by another user.	20040205
3	INTERNAL_ERROR	☐	anderer interner Fehler	20031127
4	NOTHING_FOUND	☐	Kommentar	20031127
5	WRONG_DOCID	☐		20031229

Method GET_COMMENT_MODEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_MODEL			20031215

Method GET_COMMENT_MODEL on class CL_UC_COMMENT_DATA has no exception.

Method GET_GUI_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMMENT_LIST	Call by reference	☐	Type reference (TYPE)	UCC0_T_COMMENT_ATTRIBUT		Directory of comments (only Header Info)	20031204
2	Exporting	E_LAYOUT_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1		'V'=Vertical layout, 'H'=Horizontal layout	20031204

Method GET_GUI_DATA on class CL_UC_COMMENT_DATA has no exception.

Method GET_GUI_LAYOUTMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LAYOUT_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1			20040401

Method GET_GUI_LAYOUTMODE on class CL_UC_COMMENT_DATA has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_CUST_DATA		Interne Sicht auf Customizing-Daten	20031126
2	Importing	IO_APPL	Call by reference	☑	Object reference (TYPE REF TO)	IF_UC_COMMENT_APPLICATION		Comment hosting application	20040108
3	Importing	IO_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_MODEL			20031215
4	Importing	IO_SEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_SEL		Interface Selektionsbedingung	20031126
5	Importing	I_LAYOUT_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1		'V': vertical layout, 'H': horizontal layout	20031204
6	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	UC_COMMENT_TYPE		Type des Kommentares	20031126

Method GET_INSTANCE on class CL_UC_COMMENT_DATA has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_MODEL			20040113
2	Importing	IO_SEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_SEL		Interface Selektionsbedingung	20031126
3	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	UC_COMMENT_TYPE		Type des Kommentares	20031126

Method INIT on class CL_UC_COMMENT_DATA has no exception.

Method SAVE_ONE_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_BUFFER_CONTENT	Call by reference	☐	Type reference (TYPE)	S_BUFFER_CONTENT			20040115

#	Exception	Resumable	Description	Created on
1	DELETE_FAILED	☐		20040113
2	FOREIGN_LOCK	☐		20040205
3	INSERT_FAILED	☐		20040113
4	MODIFY_FAILED	☐		20040113
5	RFC_ERROR	☐		20040205

Method SET_GUI_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_COMMENT_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	UCC0_S_COMMENT_ATTRIBUT			20040113
2	Importing	IT_COMMENT_ASC	Call by reference	☑	Type reference (TYPE)	UCC0_T_ASCII_CONTENT		ASCII-Tabelle	20031204
3	Importing	IT_COMMENT_BIN	Call by reference	☑	Type reference (TYPE)	UCC0_T_CONTENT		Inhalt eines Dokuments Binär	20031204
4	Importing	I_DOACTION	Call by reference	☐	Type reference (TYPE)	CHAR2			20040113
5	Importing	I_DOCID	Call by reference	☐	Type reference (TYPE)	UCC0_Y_DOCID		Attribute eines Kommentares	20031204

Method SET_GUI_DATA on class CL_UC_COMMENT_DATA has no exception.

Method UNLOAD_DATA Signature

Method UNLOAD_DATA on class CL_UC_COMMENT_DATA has no parameter.
Method UNLOAD_DATA on class CL_UC_COMMENT_DATA has no exception.

History

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