SAP ABAP Class CL_BCS_ADMIN_MANAGER (BCS: Administration)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-COM (Application Component) Communication Services: Mail, Fax, SMS, Telephony
     ⤷ SBCS_ADM (Package) Business Communication Services: Administration

Properties

Class	CL_BCS_ADMIN_MANAGER
Short Description	BCS: Administration
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SBCS_ADM	Business Communication Services: Administration
Created	20081022	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BCS_ADMIN_MANAGER has no forward declaration.

Interfaces

Class CL_BCS_ADMIN_MANAGER has no interface implemented.

Friends

Class CL_BCS_ADMIN_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_BACKGROUND	Constant	Public	☐	Type reference (TYPE)	C	'B'	Start Report in the Background	20090210
2	C_DIALOG	Constant	Public	☐	Type reference (TYPE)	C	'D'	Start Report in Dialog	20090210
3	C_DOCU_REPORT	Constant	Private	☐	Type reference (TYPE)	DOKU_ID	'RE'	Report Text	20090210
4	C_DOCU_TEXT	Constant	Private	☐	Type reference (TYPE)	DOKU_ID	'TX'	General Text	20090210
5	C_DYN_BUTTON_DOCU	Constant	Public	☐	Type reference (TYPE)	SYDYNNR	'0102'	Buttons and Documentation	20090210
6	C_DYN_DOCU	Constant	Public	☐	Type reference (TYPE)	SYDYNNR	'0101'	Documentation Only	20090210
7	C_DYN_EXTERN	Constant	Public	☐	Type reference (TYPE)	SYDYNNR	'0103'	External Application	20090210
8	C_DYN_EXTERN_FRAME	Constant	Public	☐	Type reference (TYPE)	SYDYNNR	'0104'	External Application <128 Columns	20090210
9	C_DYN_SPLITTER	Constant	Public	☐	Type reference (TYPE)	SYDYNNR	'0105'	Splitter	20090210
10	C_FUNCTION	Constant	Private	☐	Type reference (TYPE)	C	'F'	Function Module	20090210
11	C_JOB	Constant	Public	☐	Type reference (TYPE)	C	'J'	Schedule Report as Job	20090210
12	C_MODE_BACKGROUND	Constant	Public	☐	Type reference (TYPE)	I	2	Execute in Background	20090210
13	C_MODE_DIALOG	Constant	Public	☐	Type reference (TYPE)	I	1	Execute in Dialog Mode	20090210
14	C_MODE_JOB	Constant	Public	☐	Type reference (TYPE)	I	4	Schedule as Job	20090210
15	C_REPORT	Constant	Private	☐	Type reference (TYPE)	C	'R'	Report	20090210
16	C_ROOT	Constant	Public	☐	Type reference (TYPE)	STRING	'ROOT'	Root Node	20090210
17	C_STATUS_ADMIN	Constant	Public	☐	Type reference (TYPE)	STRING	'BCS_ADMIN'	General Status	20090210
18	C_STATUS_REPORT	Constant	Public	☐	Type reference (TYPE)	STRING	'BCS_REPORT'	Status with Execute Function	20090210
19	C_STYLESHEET	Constant	Private	☐	Type reference (TYPE)	BDS_TYPEID	'RSBCS_ADMIN'	Stylesheet in BDS	20090210
20	GO_ADMIN_MANAGER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_BCS_ADMIN_MANAGER		BCS: Administration	20090210
21	GV_OKCODE	Static Attribute	Private	☐	Type reference (TYPE)	SY-UCOMM		Function Code that Triggered PAI	20090210
22	MO_DYDOC	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DD_DOCUMENT		Dynamic Documents: Document	20090210
23	MO_DYDOC_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Documentation	20090210
24	MO_NAV_TREE	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_BCS_TREE		Tree Manager for BCS Administration	20090210
25	MT_ADMIN_DATA	Instance attribute	Private	☐	See coding				20090210
26	MV_DYNNR	Instance attribute	Private	☐	Type reference (TYPE)	SYDYNNR		Frame Screen Number	20090210
27	MV_REFRESH_DYDOC	Instance attribute	Private	☐	Type reference (TYPE)	SAP_BOOL		Refill Dynamic Document with Content	20090210
28	MV_REPORT	Instance attribute	Private	☐	Type reference (TYPE)	SYREPID		Master Program	20090210
29	MV_SEQUENCE_CALL	Instance attribute	Private	☐	Type reference (TYPE)	SAP_BOOL		Reuse of Dynamic Document	20090210
30	MV_TAB	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Selected Tab in External Screen	20090210
31	MV_TREE_VISIBLE	Instance attribute	Private	☐	Type reference (TYPE)	SAP_BOOL		Navigation tree visible/hidden	20090210

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_REPORT_EXISTENCE	Instance method	Private	Method	Check Existence of a Report	20090210
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090210
3	CREATE_CONTAINER	Instance method	Private	Method	Generate Custom Container	20090210
4	CREATE_DYDOC	Instance method	Private	Method	Generate Dynamic Document	20090210
5	CREATE_NAVIGATION_TREE	Instance method	Private	Method	Generate Tree Navigation	20090210
6	DISPLAY_DYDOC	Instance method	Public	Method	Display Dynamic Document	20090210
7	EXECUTE_REPORT	Instance method	Public	Method	Execute Report	20090210
8	FILL_DYDOC_WITH_DATA	Instance method	Public	Method	Fill Dynamic Document with Data	20090210
9	FILL_TREE_BCS	Instance method	Private	Method	Filling Navigation Tree (BCS)	20100512
10	FILL_TREE_GOS	Instance method	Private	Method	Filling Navigation Tree (GOS)	20100512
11	FILL_TREE_REL	Instance method	Private	Method	Filling Navigation Tree (REL)	20100512
12	FREE	Instance method	Public	Method	Release Instances	20090210
13	GET_ACTIVE_DATA	Instance method	Public	Method	Read Data for Selection	20090210
14	GET_ACTIVE_TREE_NODE	Instance method	Public	Method	Read Selection in Tree	20090210
15	GET_INSTANCE	Static method	Public	Method	Get Instance	20090210
16	GET_OKCODE	Static method	Public	Method	Read OK Code	20090210
17	GET_TAB	Instance method	Public	Method	Read Selected Title Elements	20090210
18	GET_TREE_NODES	Instance method	Private	Method	Structure of the Navigation Tree	20090210
19	GET_TREE_WIDTH	Instance method	Public	Method	Read Width of the Navigation Tree	20090210
20	GET_VARIANT	Instance method	Private	Method	Select Variant for Report	20090210
21	INITIALIZE	Instance method	Public	Method	Initialization	20090210
22	INITIALIZE_DYDOC	Instance method	Public	Method	Initialize Dynamic Document	20090210
23	ON_NODE_DOUBLE_CLICK	Instance method	Private	Event handling method	Event Handler	20090210
24	READ_DOCU_OBJECT	Instance method	Private	Method	Read the Documentation	20090210
25	SCHEDULE_REPORT	Instance method	Private	Method	Schedule Report	20090210
26	SET_ACTIVE_TREE_NODE	Instance method	Public	Method	Set Selection in Tree	20090210
27	SET_OKCODE	Static method	Public	Method	Set OK Code	20090210
28	SET_TAB	Instance method	Public	Method	Set Selected Title Elements	20090210
29	SHOW_SCHEDULE	Instance method	Public	Method	Display Scheduled Jobs	20090210
30	START	Static method	Public	Method	Call of BCS Administration Interface	20090210
31	START_FUNCTION	Instance method	Private	Method	Start Function	20090210
32	START_REPORT	Instance method	Private	Method	Start Report in Dialog	20090210
33	SUBMIT_REPORT	Instance method	Private	Method	Start Report in the Background	20090210
34	TOGGLE_TREE_VISIBLE	Instance method	Public	Method	Show/Hide Navigation Tree	20090210

Events

Class CL_BCS_ADMIN_MANAGER has no event.

Types

Class CL_BCS_ADMIN_MANAGER has no local type.

Method Signatures

Method CHECK_REPORT_EXISTENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REPORT	Call by reference	☐	Type reference (TYPE)	SYREPID		ABAP-Programm, aktuelles Rahmenprogramm	20090210
2	Returning	RV_TYPE	Value transfer	☐	Type reference (TYPE)	CHAR1		Report oder Funktion	20090210

#	Exception	Resumable	Description	Created on
1	CX_BCS_ADMIN	☐	BCS: Ausnahmen Administration	20090210

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPL	Call by reference	☐	Type reference (TYPE)	STRING	'BCS'	Anwendung (BCS/REL/GOS)	20100512
2	Importing	IV_DYNNR	Call by reference	☑	Type reference (TYPE)	SYDYNNR		Aktuelle Dynpro-Nummer	20090210
3	Importing	IV_REPORT	Call by reference	☑	Type reference (TYPE)	SYREPID		ABAP-Programm, aktuelles Rahmenprogramm	20090210

Method CONSTRUCTOR on class CL_BCS_ADMIN_MANAGER has no exception.

Method CREATE_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTAINER_NAME	Call by reference	☐	Type reference (TYPE)	C			20090210
2	Returning	RO_CONTAINER	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container fuer Custom Controls in der Dynpro Area	20090210

Method CREATE_CONTAINER on class CL_BCS_ADMIN_MANAGER has no exception.

Method CREATE_DYDOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_DYDOC	Value transfer	☐	Object reference (TYPE REF TO)	CL_DD_DOCUMENT		Dynamische Dokumente: Dokument	20090210

Method CREATE_DYDOC on class CL_BCS_ADMIN_MANAGER has no exception.

Method CREATE_NAVIGATION_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_TREE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCS_TREE		Tree Manager für BCS Administration	20090210

Method CREATE_NAVIGATION_TREE on class CL_BCS_ADMIN_MANAGER has no exception.

Method DISPLAY_DYDOC Signature

Method DISPLAY_DYDOC on class CL_BCS_ADMIN_MANAGER has no parameter.
Method DISPLAY_DYDOC on class CL_BCS_ADMIN_MANAGER has no exception.

Method EXECUTE_REPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	C	'D'	Modus (C_DIALOG/C_BACKGROUND)	20090210

Method EXECUTE_REPORT on class CL_BCS_ADMIN_MANAGER has no exception.

Method FILL_DYDOC_WITH_DATA Signature

Method FILL_DYDOC_WITH_DATA on class CL_BCS_ADMIN_MANAGER has no parameter.
Method FILL_DYDOC_WITH_DATA on class CL_BCS_ADMIN_MANAGER has no exception.

Method FILL_TREE_BCS Signature

Method FILL_TREE_BCS on class CL_BCS_ADMIN_MANAGER has no parameter.
Method FILL_TREE_BCS on class CL_BCS_ADMIN_MANAGER has no exception.

Method FILL_TREE_GOS Signature

Method FILL_TREE_GOS on class CL_BCS_ADMIN_MANAGER has no parameter.
Method FILL_TREE_GOS on class CL_BCS_ADMIN_MANAGER has no exception.

Method FILL_TREE_REL Signature

Method FILL_TREE_REL on class CL_BCS_ADMIN_MANAGER has no parameter.
Method FILL_TREE_REL on class CL_BCS_ADMIN_MANAGER has no exception.

Method FREE Signature

Method FREE on class CL_BCS_ADMIN_MANAGER has no parameter.
Method FREE on class CL_BCS_ADMIN_MANAGER has no exception.

Method GET_ACTIVE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ADMIN_DATA	Value transfer	☐	Type reference (TYPE)	BCSS_ADMIN_DATA		BCS Administration	20090210

Method GET_ACTIVE_DATA on class CL_BCS_ADMIN_MANAGER has no exception.

Method GET_ACTIVE_TREE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NODE	Value transfer	☐	Type reference (TYPE)	STRING			20090210

Method GET_ACTIVE_TREE_NODE on class CL_BCS_ADMIN_MANAGER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCS_ADMIN_MANAGER		BCS: Administration	20090210

Method GET_INSTANCE on class CL_BCS_ADMIN_MANAGER has no exception.

Method GET_OKCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OKCODE	Value transfer	☐	Type reference (TYPE)	SY-UCOMM		Funktionscode, der PAI ausgelöst hat	20090210

Method GET_OKCODE on class CL_BCS_ADMIN_MANAGER has no exception.

Method GET_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TAB	Value transfer	☐	Type reference (TYPE)	STRING			20090210

Method GET_TAB on class CL_BCS_ADMIN_MANAGER has no exception.

Method GET_TREE_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_NODES	Value transfer	☐	Type reference (TYPE)	TREEMSNOTA		Simple Tree Model: Knotentabelle	20090210

Method GET_TREE_NODES on class CL_BCS_ADMIN_MANAGER has no exception.

Method GET_TREE_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TREE_WIDTH	Value transfer	☐	Type reference (TYPE)	I		Breite des Naviagationsbaums	20090210

Method GET_TREE_WIDTH on class CL_BCS_ADMIN_MANAGER has no exception.

Method GET_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REPORT_NAME	Call by reference	☐	Type reference (TYPE)	SYREPID		ABAP-Programm, aktuelles Rahmenprogramm	20090210
2	Returning	RV_VARIANT	Value transfer	☐	Type reference (TYPE)	RALDB_VARI		Variantenname	20090210

Method GET_VARIANT on class CL_BCS_ADMIN_MANAGER has no exception.

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ADMIN_MANAGER	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCS_ADMIN_MANAGER		BCS: Administration	20090210

Method INITIALIZE on class CL_BCS_ADMIN_MANAGER has no exception.

Method INITIALIZE_DYDOC Signature

Method INITIALIZE_DYDOC on class CL_BCS_ADMIN_MANAGER has no parameter.
Method INITIALIZE_DYDOC on class CL_BCS_ADMIN_MANAGER has no exception.

Method ON_NODE_DOUBLE_CLICK Signature

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

Method ON_NODE_DOUBLE_CLICK on class CL_BCS_ADMIN_MANAGER has no exception.

Method READ_DOCU_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOCU_ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID		Dokumentenklasse	20090210
2	Importing	IV_DOCU_OBJECT	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Dokumentations-Objekt	20090210
3	Returning	RV_HTML	Value transfer	☐	Type reference (TYPE)	STRING		HTML String	20090210

#	Exception	Resumable	Description	Created on
1	CX_BCS_ADMIN	☐	BCS: Ausnahmen Administration	20090210

Method SCHEDULE_REPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REPORT_NAME	Call by reference	☐	Type reference (TYPE)	SYREPID		ABAP-Programm, aktuelles Rahmenprogramm	20090210

#	Exception	Resumable	Description	Created on
1	CX_BCS_ADMIN	☐	BCS: Ausnahmen Administration	20090210

Method SET_ACTIVE_TREE_NODE Signature

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

Method SET_ACTIVE_TREE_NODE on class CL_BCS_ADMIN_MANAGER has no exception.

Method SET_OKCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OKCODE	Call by reference	☐	Type reference (TYPE)	SY-UCOMM		Funktionscode, der PAI ausgelöst hat	20090210

Method SET_OKCODE on class CL_BCS_ADMIN_MANAGER has no exception.

Method SET_TAB Signature

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

Method SET_TAB on class CL_BCS_ADMIN_MANAGER has no exception.

Method SHOW_SCHEDULE Signature

Method SHOW_SCHEDULE on class CL_BCS_ADMIN_MANAGER has no parameter.
Method SHOW_SCHEDULE on class CL_BCS_ADMIN_MANAGER has no exception.

Method START Signature

Method START on class CL_BCS_ADMIN_MANAGER has no parameter.
Method START on class CL_BCS_ADMIN_MANAGER has no exception.

Method START_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FUNCTION_NAME	Call by reference	☐	Type reference (TYPE)	FUNCNAME		Tabelle der Funktionseinträge für Transaktion SVPQ	20090210

#	Exception	Resumable	Description	Created on
1	CX_BCS_ADMIN	☐	BCS: Ausnahmen Administration	20090210

Method START_REPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REPORT_NAME	Call by reference	☐	Type reference (TYPE)	SYREPID		ABAP-Programm, aktuelles Rahmenprogramm	20090210

#	Exception	Resumable	Description	Created on
1	CX_BCS_ADMIN	☐	BCS: Ausnahmen Administration	20090210

Method SUBMIT_REPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REPORT_NAME	Call by reference	☐	Type reference (TYPE)	SYREPID		ABAP-Programm, aktuelles Rahmenprogramm	20090210

#	Exception	Resumable	Description	Created on
1	CX_BCS_ADMIN	☐	BCS: Ausnahmen Administration	20090210

Method TOGGLE_TREE_VISIBLE Signature

Method TOGGLE_TREE_VISIBLE on class CL_BCS_ADMIN_MANAGER has no parameter.
Method TOGGLE_TREE_VISIBLE on class CL_BCS_ADMIN_MANAGER has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	703