SAP ABAP Class CL_REVIEW_TOOL (Authoring Environment for Review)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ SV-ASA (Application Component) ASAP (AcceleratedSAP)
     ⤷ SQADB (Package) Question and Answer Database

Properties

Class	CL_REVIEW_TOOL
Short Description	Authoring Environment for Review
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SQADB	Question and Answer Database
Created	20000328	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_REVIEW_STRUCTURE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_REVIEW_TOOL has no interface implemented.

Friends

Class CL_REVIEW_TOOL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	A_EDIT_MODE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		NEW = 'N'; Edit = 'E'; Display = 'D'	20000329
2	A_EXPAND_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		'Expand' Button Active	20000607
3	A_HANDLER_OKCODE	Instance attribute	Private	☐	Type reference (TYPE)	SYUCOMM		OK Code from Handler Method	20000504
4	A_MAIN_DYNNR	Instance attribute	Private	☐	Type reference (TYPE)	SYDYNNR		Subscreen Container (Screen Number)	20000328
5	A_MAIN_REPID	Instance attribute	Private	☐	Type reference (TYPE)	SYREPID		Subscreen Container (Programs)	20000328
6	A_ROOT_STRUCTURE_ID	Instance attribute	Public	☑	Type reference (TYPE)	TTREE-TREE_ID		Unique ID - 32 characters	20000503
7	A_SELECTED_QUEID	Instance attribute	Private	☐	Type reference (TYPE)	SQADB01-QUEID		Question in Structure or Pool for Processing	20000727
8	A_SQADB01	Instance attribute	Private	☐	Type reference (TYPE)	SQADB01_S		Current Selected Question (Data)	20000328
9	A_STRUCTURE_ID	Instance attribute	Private	☐	Type reference (TYPE)	TTREE-ID		Current Edited Structure	20000329
10	A_SUB_DYNNR	Instance attribute	Private	☐	Type reference (TYPE)	SYDYNNR		Current Subscreen (Screen Number)	20000328
11	A_SUB_REPID	Instance attribute	Private	☐	Type reference (TYPE)	SYREPID		Current Subscreen (Programs)	20000328
12	C_DUMMY_DYNNR	Constant	Public	☐	Type reference (TYPE)	SYDYNNR	'9999'	Empty Screen	20000331
13	C_DUMMY_REPID	Constant	Public	☐	Type reference (TYPE)	SYREPID	'SAPLSQAREV'	Report for Empty Screen	20000331
14	C_FCODE_BACK	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'BACK'	OK Code: Back	20000410
15	C_FCODE_CHANGE_QUESTION	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'CHANGE'	OK Code: Change	20000404
16	C_FCODE_COPY_QUESTION	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'COPY'	OK Code: Copy Question	20010109
17	C_FCODE_DELETE_QUESTION	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'DELETE'	OK Code: Delete Question	20000331
18	C_FCODE_DUMMY	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'Dummy'	Dummy OK Code for Process After Input	20000825
19	C_FCODE_END	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'END'	OK Code: Exit	20000410
20	C_FCODE_EXIT	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'EXIT'	OK Code: Cancel	20000410
21	C_FCODE_FILTER	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'FILTER'	OK Code: Set Filter	20000331
22	C_FCODE_MAINTAIN_DOKU	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'MDOKU'	OK Code: Switch to Document Maintenance	20000531
23	C_FCODE_MAINTAIN_FLAVOR	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'MFLAV'	OK Code: Switch to Flavor Maintenance	20000531
24	C_FCODE_MAINTAIN_RELEASE	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'MRELS'	OK Code: Switch to Release Maintenance	20000531
25	C_FCODE_MAINTAIN_ROLE	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'MROLE'	OK Code: Switch to Role Maintenance	20000531
26	C_FCODE_MAINTAIN_SUBJECT	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'MSUB'	OK Code: Switch to Subcategories	20000531
27	C_FCODE_MAINTAIN_TOPIC	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'MTOP'	OK Code: Switch to Categories	20000531
28	C_FCODE_NEW_QUESTION	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'NEW'	OK Code: Create	20000404
29	C_FCODE_NEW_STRUCTURE	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'NEWS'	OK Code: Switch to New Structure	20000503
30	C_FCODE_SAVE_QUESTION	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'REV_SAVE'	OK Code: Save	20000404
31	C_FCODE_SHOW_QUESTION	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'SHOW'	OK Code: Display	20000404
32	C_FCODE_TOGGLE	Constant	Public	☐	Type reference (TYPE)	SYUCOMM	'TOGL'	OK Code: Switch	20000331
33	C_INTRO_DYNNR	Constant	Public	☐	Type reference (TYPE)	SYDYNNR	'0050'	Screen with Picture Control	20000503
34	C_MODE_CHANGE	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1	'E'	Change Mode: Change Question	20000523
35	C_MODE_NEW	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1	'N'	Change Mode: Create Question	20000523
36	C_MODE_SHOW	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1		Change Mode: Change Question	20000523
37	R_PICTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_PICTURE		Picture Control for Initial Screen	20000413
38	R_PICTURE_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Custom Controls in the Screen Area	20000413
39	R_POOL_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_DOCKING_CONTAINER		Container for Question Pool	20000328
40	R_QPOOL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_REV_POOL		Question Pool	20000328
41	R_STRUCTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_REVIEW_STRUCTURE		Authoring Environment for Review	20000330
42	R_STRUCTURE_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_DOCKING_CONTAINER		Container for Structure	20000328

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_AND_SAVE	Instance method	Private	Method	Checks for Data Changes and Confirms Dialog Box	20000412
2	CHECK_AND_SAVE_OBJECT	Instance method	Private	Method	Checks Whether Exit of Object Maintenance Dialog Possible	20000411
3	CHECK_DATA_CHANGED	Instance method	Private	Method	Checks for Changed Data in Transaction	20000411
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000328
5	COPY_QUESTION	Instance method	Private	Method	Copies Question Entered	20010109
6	DELETE_QUESTION	Instance method	Private	Method	Deletes Question	20000504
7	GET_ACUTAL_QUESTION	Instance method	Public	Method	Provides Question Currently Being Edited	20000522
8	GET_DISABLED_FCODES	Instance method	Public	Method	Provides Table with All Inactive Function Codes	20000718
9	GET_HIERARCHY	Instance method	Public	Method	Provides Reference to Hierarchy Wrapper	20000412
10	GET_PF_STATUS	Instance method	Public	Method	Provides GR Status	20000718
11	HANDLE_POOL_FUNCTION_SELECTED	Instance method	Protected	Event handling method	Handles Question Pool Functions	20000331
12	HANDLE_POOL_QUESTION_SELECTED	Instance method	Protected	Event handling method	Event Handler for Question Selection in Question Pool	20000328
13	HANDLE_REF_SELECTED	Instance method	Private	Event handling method	Event Handler for Selecting Reference Objects	20000727
14	HANDLE_STRUC_QUESTION_DELETED	Instance method	Protected	Event handling method	Event Handler for Deleting Question from Structure	20000825
15	HANDLE_STRUC_QUESTION_INSERTED	Instance method	Protected	Event handling method	Event Handler for Inserting Question in Structure	20000504
16	HANDLE_STRUC_QUESTION_SELECTED	Instance method	Protected	Event handling method	Event Handler for Selecting Question from Structure	20000330
17	MAINTAIN_QUESTION	Instance method	Private	Method	Initializes Question Dialog for Specific Question	20000504
18	MARK_QUESTION	Instance method	Private	Method	Select Question in Structure and Question Pool	20000331
19	PBO	Instance method	Public	Method	Process Before Output Treatment	20000329
20	SAVE_ALL	Instance method	Private	Method	Saves Current Edited Object and Structure	20000504
21	SAVE_QUESTION	Instance method	Private	Method	Saves Current Question	20000504
22	SAVE_STRUCTURE	Instance method	Private	Method	Saves Current Structure	20000504
23	SET_OKCODE	Instance method	Public	Method	Sets OK Code	20000329
24	STREE_GET_STEXT	Instance method	Public	Method	Reads Structure Item Description	20000704
25	TOGGLE_MODE	Instance method	Private	Method	Switches Between Display and Change Mode	20000504
26	USER_COMMAND	Instance method	Public	Method	OK Code Treatment	20000328

Events

Class CL_REVIEW_TOOL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	USER_PARAMETERS_T	Private	See coding			20000328

Method Signatures

Method CHECK_AND_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	C		Text für Popup	20000412
2	Importing	I_TITLE	Call by reference	☐	Type reference (TYPE)	C		Titel für Popup	20000412

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000412
2	ERROR	☐	allg. Fehler	20000412

Method CHECK_AND_SAVE_OBJECT Signature

Method CHECK_AND_SAVE_OBJECT on class CL_REVIEW_TOOL has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000411
2	ERROR	☐	allg. Fehler	20000411

Method CHECK_DATA_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_CHANGED	Value transfer	☐	Type reference (TYPE)	CHAR1		'X' = Daten wurden geändert	20000411

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Fehler	20000411

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MAIN_DYNNR	Call by reference	☐	Type reference (TYPE)	SYDYNNR		Trägerdynpro für Transaktion	20000329
2	Importing	I_MAIN_REPID	Call by reference	☐	Type reference (TYPE)	SYREPID		Programname für Trägerdynpro	20000329
3	Importing	I_STRUCTURE_ID	Call by reference	☑	Type reference (TYPE)	HIER_IFACE-TREE_ID		Structur ID um Reviewtool	20000328

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000328
2	ERROR	☐	allg. Fehler	20000328

Method COPY_QUESTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUEID	Value transfer	☐	Type reference (TYPE)	SQADB01-QUEID		Eindeutige ID für Frage	20010109

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20010109
2	ERROR	☐	allg. Fehler	20010109

Method DELETE_QUESTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUEID	Call by reference	☐	Type reference (TYPE)	SQADB01-QUEID		Eindeutige ID für Frage	20000504

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000504
2	ERROR	☐	allg. Fehler	20000504
3	QUESTION_USED	☐	Frage wird gerade bearbeitet	20000504

Method GET_ACUTAL_QUESTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_SQADB01	Value transfer	☐	Type reference (TYPE)	SQADB01_S		Typdefinition für Fragenpflege	20000522

Method GET_ACUTAL_QUESTION on class CL_REVIEW_TOOL has no exception.

Method GET_DISABLED_FCODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_T_DISABLED_FCODES	Value transfer	☐	Type reference (TYPE)	SYUCOMM_T		Tabelle mit allen inaktiven Funktionscodes	20000718

Method GET_DISABLED_FCODES on class CL_REVIEW_TOOL has no exception.

Method GET_HIERARCHY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HIERARCHY	Value transfer	☐	Object reference (TYPE REF TO)	CL_REVIEW_HIERARCHY		Struktur für Review	20000412

#	Exception	Resumable	Description	Created on
1	MATCH_ERROR	☐	Hierarchieobjekt wird nicht verwendet	20000412

Method GET_PF_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_STATUS	Value transfer	☐	Type reference (TYPE)	GUI_STATUS		Menu Painter: Statuscode	20000718

Method GET_PF_STATUS on class CL_REVIEW_TOOL has no exception.

Method HANDLE_POOL_FUNCTION_SELECTED Signature

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

Method HANDLE_POOL_FUNCTION_SELECTED on class CL_REVIEW_TOOL has no exception.

Method HANDLE_POOL_QUESTION_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUEID	Call by reference	☐	Type reference (TYPE)				20000328

Method HANDLE_POOL_QUESTION_SELECTED on class CL_REVIEW_TOOL has no exception.

Method HANDLE_REF_SELECTED Signature

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

Method HANDLE_REF_SELECTED on class CL_REVIEW_TOOL has no exception.

Method HANDLE_STRUC_QUESTION_DELETED Signature

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

Method HANDLE_STRUC_QUESTION_DELETED on class CL_REVIEW_TOOL has no exception.

Method HANDLE_STRUC_QUESTION_INSERTED Signature

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

Method HANDLE_STRUC_QUESTION_INSERTED on class CL_REVIEW_TOOL has no exception.

Method HANDLE_STRUC_QUESTION_SELECTED Signature

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

Method HANDLE_STRUC_QUESTION_SELECTED on class CL_REVIEW_TOOL has no exception.

Method MAINTAIN_QUESTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUEID	Value transfer	☐	Type reference (TYPE)	SQADB01-QUEID		Eindeutige ID für Frage	20000504
2	Changing	P_OKCODE	Call by reference	☐	Type reference (TYPE)	SYUCOMM		Bildschirmbilder, Funktionscode, der PAI ausgelöst hat	20000504

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000504
2	ERROR	☐	allg. Fehler	20000504

Method MARK_QUESTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUEID	Call by reference	☐	Type reference (TYPE)	SQADB01-QUEID		Fragen	20000331

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000331
2	ERROR	☐	allg. Fehler	20000331

Method PBO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_REPID	Call by reference	☐	Type reference (TYPE)	SYREPID		Programmname des aktuellen Subscreens	20000329
2	Exporting	E_SUBNR	Call by reference	☐	Type reference (TYPE)	SYDYNNR		Dynpronummer des aktuellen Suscreen	20000329

Method PBO on class CL_REVIEW_TOOL has no exception.

Method SAVE_ALL Signature

Method SAVE_ALL on class CL_REVIEW_TOOL has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000504
2	ERROR	☐	allg. Fehler	20000504

Method SAVE_QUESTION Signature

Method SAVE_QUESTION on class CL_REVIEW_TOOL has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000504
2	ERROR	☐	allg. Fehler	20000504

Method SAVE_STRUCTURE Signature

Method SAVE_STRUCTURE on class CL_REVIEW_TOOL has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000504
2	ERROR	☐	allg. Fehler	20000504

Method SET_OKCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OKCODE	Value transfer	☐	Type reference (TYPE)	SYUCOMM		Bildschirmbilder, Funktionscode, der PAI ausgelöst hat	20000329

Method SET_OKCODE on class CL_REVIEW_TOOL has no exception.

Method STREE_GET_STEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MESSAGE	Call by reference	☐	Type reference (TYPE)	HIER_MESS		Übergabestruktur für Nachrichten	20000704
2	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		R/3-System, aktuelle Sprache	20000704
3	Importing	I_REF_TYPE	Call by reference	☐	Type reference (TYPE)	HIER_REF-REF_TYPE		Erlaubte Verweistypen in der Strukturablage	20000704
4	Importing	I_T_REF	Call by reference	☐	Type reference (TYPE)	HIER_REF_T		Verweistabelle für Knoten in der Hierarchietabelle	20000704
5	Changing	P_T_TEXT	Call by reference	☐	Type reference (TYPE)	HIER_TEXTS_T		Schnittstellentabelle für Texte in der Hierarchiepflege	20000704

Method STREE_GET_STEXT on class CL_REVIEW_TOOL has no exception.

Method TOGGLE_MODE Signature

Method TOGGLE_MODE on class CL_REVIEW_TOOL has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000504
2	ERROR	☐	allg. Fehler	20000504

Method USER_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LEAVE_TRANSACTION	Call by reference	☐	Type reference (TYPE)	CHAR1		'X' = Transaktion Verlassen	20000411
2	Importing	I_OKCODE	Call by reference	☐	Type reference (TYPE)	SYUCOMM		okcode	20000328

#	Exception	Resumable	Description	Created on
1	CANCELED	☐	User Abbruch	20000328
2	ERROR	☐	allg. Fehler	20000328

History

Last changed by/on	SAP	20110908
SAP Release Created in	46D