SAP ABAP Class CL_ILM_ARC_CENTRAL_DATA (Central Data Retention for Archiving Work Center)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ILM-WP (Application Component) ILM Workplace
     ⤷ S_ILM_ARC_ADMIN_UI (Package) ILM Work Center for Archiving: UI

Properties

Class	CL_ILM_ARC_CENTRAL_DATA
Short Description	Central Data Retention for Archiving Work Center
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ILM_ARC_ADMIN_UI	ILM Work Center for Archiving: UI
Created	20130108	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	IF_FPM_OVP	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_ILM_ARC_ADMIN_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ILM_ARC_CENTRAL_DATA has no interface implemented.

Friends

Class CL_ILM_ARC_CENTRAL_DATA has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GO_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ILM_ARC_CENTRAL_DATA		Class Instance for Central Data Container	20130108
2	GS_APPLOG_INFO	Instance attribute	Public	☐	Type reference (TYPE)	IF_ILM_ARC_ADMIN_TYPES=>TY_S_APPLOG			20130524
3	GS_EVT_PARAM_DELETE	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_EVT_PARAM_DELETE			20130306
4	GS_EVT_PARAM_POSTPROC	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_EVT_PARAM_POSTPROC			20130319
5	GS_EVT_PARAM_PREPROC	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_EVT_PARAM_PREPROC			20130315
6	GS_EVT_PARAM_STORE	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_EVT_PARAM_STORE			20130307
7	GS_EVT_PARAM_WRITE	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_EVT_PARAM_WRITE			20130212
8	GS_EVT_SET_FILE_TREE	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_EVT_SET_F_TREE			20130314
9	GS_FILE_TREE	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_FILE_TREE			20130307
10	GS_TREE_INVALID	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_TREE_INVALID			20130220
11	GTS_JOBKEY	Instance attribute	Public	☐	Type reference (TYPE)	TY_TS_JOBKEY			20130322
12	GT_AO_JOB_OVERVIEW	Instance attribute	Public	☐	Type reference (TYPE)	TY_T_AO			20130410
13	GT_AO_LIST	Instance attribute	Public	☐	Type reference (TYPE)	ILM_T_AO_DESCR		Table of Archiving Objects	20130403
14	GT_FILES	Instance attribute	Public	☐	Type reference (TYPE)	IF_ILM_ARC_ADMIN_TYPES=>TY_T_FILE			20130226
15	GT_JOBLOG	Instance attribute	Public	☐	Type reference (TYPE)	SILM_T_JOBLOG		Job Lob Entries	20130322
16	GT_PRINT_PARAMS_ACTION	Instance attribute	Public	☐	Type reference (TYPE)	TY_T_PRINT_PARAMS_ACTION			20130416
17	GT_RUNS_FILES	Instance attribute	Public	☐	Type reference (TYPE)	ARCH_T_RUNS		Archiving Sessions: Properties, Jobs, and Status	20130109
18	GT_RUNS_STATUS	Instance attribute	Public	☐	Type reference (TYPE)	TY_T_ADMI_RUNST			20130109
19	GT_SESSIONS	Instance attribute	Public	☐	Type reference (TYPE)	IF_ILM_ARC_ADMIN_TYPES=>TY_T_RUN			20130226
20	GV_ARCH_OBJ	Instance attribute	Public	☐	Type reference (TYPE)	OBJCT_TR01		Archiving Object	20130108
21	GV_ARCH_OBJ_DESCR	Instance attribute	Public	☐	Type reference (TYPE)	OBTXT_TR01		Description of the archiving object	20130115
22	GV_BTC_USER	Instance attribute	Public	☐	Type reference (TYPE)	BTCAUTHNAM		Background User Name for Authorization Check	20130523
23	GV_DSP_INCOMP_INTERRUPT_MSG	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D			20130704
24	GV_FILE	Instance attribute	Public	☐	Type reference (TYPE)	ARKEY		Key for Archive File	20130109
25	GV_GUID_AO_LIST	Instance attribute	Public	☐	Type reference (TYPE)	SYSUUID_C32		16 Byte UUID in 32 Characters (Hexadecimal Encoded)	20130405
26	GV_HEADING_IMAGE	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20130130
27	GV_HEADING_TEXT	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20130130
28	GV_ILM_USAGE	Instance attribute	Public	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20130111
29	GV_INCOMPLETE_EXIST	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D		Data Element for BOOLE Domain: TRUE (='X') and FALSE (=' ')	20130703
30	GV_INTERRUPT_EXIST	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D		Data Element for BOOLE Domain: TRUE (='X') and FALSE (=' ')	20130703
31	GV_MULTIPLE_AOS_SELECTED	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D		Job Overview: Indicates Whether Multiple AOs Are Selected	20130408
32	GV_PERIOD_SELCRIT	Instance attribute	Public	☐	Type reference (TYPE)	ILM_PERIOD		Time Period	20130403
33	GV_PRINTPARAM_INSTANCE	Instance attribute	Public	☐	Type reference (TYPE)	FPM_INSTANCE_ID		UIBB Instance ID	20130418
34	GV_READ_AUTHORITY_ONLY	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D		Data Element for BOOLE Domain: TRUE (='X') and FALSE (=' ')	20130524
35	GV_SESSION	Instance attribute	Public	☐	Type reference (TYPE)	ADMI_RUN_D		Archiving Session	20130108
36	GV_TREE_LEVEL	Instance attribute	Public	☐	Type reference (TYPE)	ILM_SESSION_TREE_NODE_TYPE		Selected Tree Level i	20130116
37	GV_VARIANT	Instance attribute	Public	☐	Type reference (TYPE)	ADMI_VARI_		Variant with which the Archiving Program Was Executed	20130207
38	MO_AO	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ILM_AO		Individual Archiving Object	20130125
39	MO_WD_MESSAGE_MANAGER	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Message Manager	20130326
40	MS_ACTION_VISIBILITY	Instance attribute	Private	☐	Type reference (TYPE)	TY_S_ACTION_VISIBILITY			20130213
41	MS_FILE_COMMENTS_UPDATE	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_FILE_COMMENTS_UPDATE			20130220
42	MS_RUN_COMMENTS_UPDATE	Instance attribute	Public	☐	Type reference (TYPE)	TY_S_RUN_COMMENTS_UPDATE			20130219
43	MT_FILE_COMMENTS_UPDATE	Instance attribute	Public	☐	Type reference (TYPE)	TY_T_FILE_COMMENTS_UPDATE			20130226
44	MT_RUN_COMMENTS_UPDATE	Instance attribute	Public	☐	Type reference (TYPE)	TY_T_RUN_COMMENTS_UPDATE			20130226
45	MV_EDIT_FILE_DETAILS	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D		File Details Are Being Edited	20130218
46	MV_EDIT_RUN_DETAILS	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D		Run Details Are Being Edited	20130218

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130523
2	GET_ACTION_VISIBILITY	Instance method	Public	Method	Gets Visibility of Archiving Actions	20130213
3	GET_AO	Instance method	Public	Method	Gets Instance of CL_ILM_AO for GV_ARCH_OBJ	20130125
4	GET_FILE_DETAILS	Instance method	Public	Method	Gets File Details	20130109
5	GET_ICON_TEXT_FOR_MSGTY	Static method	Public	Method	Gets Icon and Text for Message Type	20130524
6	GET_INSTANCE	Static method	Public	Method	Instance Determination	20130108
7	GET_SESSION_DETAILS	Instance method	Public	Method	Gets Session Details	20130109
8	INITIALIZE	Instance method	Public	Method	Retrieves Session and File Data for an AO	20130109
9	MSG_HAS_LONGTEXT	Static method	Public	Method		20130524
10	NAVIGATE_TO_MAINTAIN_VARIANT	Instance method	Public	Method	Navigate to Variant Maintenance in SAPGUI	20130425
11	NAVIGATE_TO_SPOOL	Instance method	Public	Method	Navigate to Spool or Spool List in SAPGUI	20130416
12	SET_FILE_COMMENTS	Instance method	Public	Method	Set Comment for File	20130220
13	SET_RUN_COMMENTS	Instance method	Public	Method	Set Comment for Session	20130220
14	SUBSTRACT_MONTHS_FROM_TODAY	Static method	Public	Method	Calculate a Date that Lies a Number of Months in the Past	20130405

Events

Class CL_ILM_ARC_CENTRAL_DATA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_ACTION_VISIBILITY	Public	See coding			20130213	BEGIN OF ty_s_action_visibility, preproc TYPE fpm_visibility, write TYPE fpm_visibility, delete TYPE fpm_visibility, postproc TYPE fpm_visibility, store TYPE fpm_visibility, valid TYPE fpm_visibility, END OF ty_s_action_visibility
2	TY_S_DEL_TREE_BTN_ENA	Public	See coding			20130312	BEGIN OF ty_s_del_tree_btn_ena, start TYPE boole_d, start_in_testmode TYPE boole_d, END OF ty_s_del_tree_btn_ena
3	TY_S_EP_UIBB_SCHEDULE	Public	See coding			20130307	BEGIN OF ty_s_ep_uibb_schedule, valid TYPE boole_d, schedule TYPE ilm_s_schedule, END OF ty_s_ep_uibb_schedule
4	TY_S_EP_UIBB_TREE_FILE	Public	See coding			20130307	BEGIN OF ty_s_ep_uibb_tree_file, valid TYPE boole_d, sel_files TYPE cl_ilm_job_manager=>ty_t_run_file, END OF ty_s_ep_uibb_tree_file
5	TY_S_EP_WRITE_UIBB_VARIANT	Public	See coding			20130212	BEGIN OF ty_s_ep_write_uibb_variant, valid TYPE boole_d, variant TYPE admi_vari_, comment TYPE admi_text, END OF ty_s_ep_write_uibb_variant
6	TY_S_EVT_PARAM_DELETE	Public	See coding			20130306	BEGIN OF ty_s_evt_param_delete, uibb_schedule TYPE ty_s_ep_uibb_schedule, uibb_tree TYPE ty_s_ep_uibb_tree_file, END OF ty_s_evt_param_delete
7	TY_S_EVT_PARAM_POSTPROC	Public	See coding			20130319	BEGIN OF ty_s_evt_param_postproc, uibb_variant TYPE ty_s_ep_write_uibb_variant, uibb_schedule TYPE ty_s_ep_uibb_schedule, END OF ty_s_evt_param_postproc
8	TY_S_EVT_PARAM_PREPROC	Public	See coding			20130315	BEGIN OF ty_s_evt_param_preproc, uibb_variant TYPE ty_s_ep_write_uibb_variant, uibb_schedule TYPE ty_s_ep_uibb_schedule, END OF ty_s_evt_param_preproc
9	TY_S_EVT_PARAM_STORE	Public	See coding			20130307	BEGIN OF ty_s_evt_param_store, uibb_schedule TYPE ty_s_ep_uibb_schedule, uibb_tree TYPE ty_s_ep_uibb_tree_file, popup_mode TYPE string, END OF ty_s_evt_param_store
10	TY_S_EVT_PARAM_WRITE	Public	See coding			20130212	BEGIN OF ty_s_evt_param_write, uibb_variant TYPE ty_s_ep_write_uibb_variant, uibb_schedule TYPE ty_s_ep_uibb_schedule, END OF ty_s_evt_param_write
11	TY_S_EVT_SET_D_TREE	Public	See coding			20130314	BEGIN OF ty_s_evt_set_d_tree, button_enabled TYPE ty_s_del_tree_btn_ena, END OF ty_s_evt_set_d_tree
12	TY_S_EVT_SET_F_TREE	Public	See coding			20130314	BEGIN OF ty_s_evt_set_f_tree, delete_tree TYPE ty_s_evt_set_d_tree, store_tree TYPE ty_s_evt_set_s_tree, END OF ty_s_evt_set_f_tree
13	TY_S_EVT_SET_S_TREE	Public	See coding			20130314	BEGIN OF ty_s_evt_set_s_tree, button_enabled TYPE ty_s_sto_tree_btn_ena, END OF ty_s_evt_set_s_tree
14	TY_S_FILE_COMMENTS_UPDATE	Public	See coding			20130220	BEGIN OF ty_s_file_comments_update, archiv_key TYPE arkey, comments TYPE admi_text, END OF ty_s_file_comments_update
15	TY_S_FILE_TREE	Public	See coding			20130307	BEGIN OF ty_s_file_tree, set_selection_delete TYPE boole_d, set_selection_store TYPE boole_d, reset_selection_delete TYPE boole_d, reset_selection_store TYPE boole_d, delete_tree_invalid TYPE boole_d, store_tree_invalid TYPE boole_d, END OF ty_s_file_tree
16	TY_S_JOBKEY	Public	See coding			20130322	BEGIN OF ty_s_jobkey, instance_id TYPE fpm_instance_id, jobname TYPE btcjob, jobcount TYPE btcjobcnt, END OF ty_s_jobkey
17	TY_S_PRINT_PARAMS_ACTION	Public	See coding			20130416	BEGIN OF ty_s_print_params_action, instance_id TYPE fpm_instance_id, include TYPE ilm_s_print_params, END OF ty_s_print_params_action
18	TY_S_RUN_COMMENTS_UPDATE	Public	See coding			20130220	BEGIN OF ty_s_run_comments_update, document TYPE admi_run_d, comments TYPE admi_text, END OF ty_s_run_comments_update
19	TY_S_STO_TREE_BTN_ENA	Public	See coding			20130314	BEGIN OF ty_s_sto_tree_btn_ena, start TYPE boole_d, start_in_testmode TYPE boole_d, END OF ty_s_sto_tree_btn_ena
20	TY_S_TREE_INVALID	Public	See coding			20130220	BEGIN OF ty_s_tree_invalid, invalid TYPE boole_d, read_from_db TYPE boole_d, END OF ty_s_tree_invalid
21	TY_TS_JOBKEY	Public	See coding			20130322	ty_ts_jobkey TYPE SORTED TABLE OF ty_s_jobkey WITH UNIQUE KEY instance_id
22	TY_T_ADMI_RUNST	Public	See coding			20130109	ty_t_admi_runst TYPE STANDARD TABLE OF admi_runst
23	TY_T_AO	Public	See coding			20130410	ty_t_ao TYPE STANDARD TABLE OF objct_tr01
24	TY_T_FILE_COMMENTS_UPDATE	Public	See coding			20130226	ty_t_file_comments_update TYPE TABLE OF ty_s_file_comments_update
25	TY_T_PRINT_PARAMS_ACTION	Public	See coding			20130416	ty_t_print_params_action TYPE STANDARD TABLE OF ty_s_print_params_action
26	TY_T_RUN_COMMENTS_UPDATE	Public	See coding			20130226	ty_t_run_comments_update TYPE TABLE OF ty_s_run_comments_update

Method Signatures

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_ILM_ARC_CENTRAL_DATA has no parameter.
Method CONSTRUCTOR on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method GET_ACTION_VISIBILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ACTION_VISIBILITY	Value transfer	☐	Type reference (TYPE)	TY_S_ACTION_VISIBILITY			20130213

Method GET_ACTION_VISIBILITY on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method GET_AO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_AO	Value transfer	☐	Object reference (TYPE REF TO)	IF_ILM_AO		Einzelnes Archivierungsobjekt	20130125

#	Exception	Resumable	Description	Created on
1	CX_ILM_AO	☐	Ausnahmeklasse für cl_ilm_ao	20130211

Method GET_FILE_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ADMI_FILE	Value transfer	☐	Type reference (TYPE)	ADMI_FILES		Archivdateien der Archivierungsläufe	20130109

Method GET_FILE_DETAILS on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method GET_ICON_TEXT_FOR_MSGTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ICON	Call by reference	☐	Type reference (TYPE)	STRING			20130524
2	Exporting	EV_TEXT	Call by reference	☐	Type reference (TYPE)	NAME_KOMP		Komponentenname	20130524
3	Importing	IV_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Nachrichtentyp	20130524

Method GET_ICON_TEXT_FOR_MSGTY on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ILM_ARC_CENTRAL_DATA		Instanz der zentralen Daten	20130108

Method GET_INSTANCE on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method GET_SESSION_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_WITH_OBJCOUNT	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20130211
2	Returning	RS_SESSION_DETAILS	Value transfer	☐	Type reference (TYPE)	ILM_S_RUN_DETAILS		Archivierungsläufe Kopfdaten	20130109

Method GET_SESSION_DETAILS on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method INITIALIZE Signature

Method INITIALIZE on class CL_ILM_ARC_CENTRAL_DATA has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ILM_T100	☐	cx_ilm_t100	20130211

Method MSG_HAS_LONGTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID		Nachrichtenklasse	20130524
2	Importing	IV_MSGNO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Nachrichtennummer	20130524
3	Returning	RV_LONGTEXT_EXIST	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20130524

Method MSG_HAS_LONGTEXT on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method NAVIGATE_TO_MAINTAIN_VARIANT 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)	RALDB_REPO		Reportname	20130425
2	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	RALDB_VARI		Variantenname	20130425

Method NAVIGATE_TO_MAINTAIN_VARIANT on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method NAVIGATE_TO_SPOOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOBCOUNT	Call by reference	☑	Type reference (TYPE)	BTCJOBCNT		Kennummer eines Jobs	20130416
2	Importing	IV_JOBNAME	Call by reference	☑	Type reference (TYPE)	BTCJOB		Name eines Hintergrundjobs	20130416
3	Importing	IV_SPOOLID	Call by reference	☑	Type reference (TYPE)	RQIDENT		Spool-Nummer	20130416

Method NAVIGATE_TO_SPOOL on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method SET_FILE_COMMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIV_KEY	Call by reference	☐	Type reference (TYPE)	ARKEY		Schlüssel einer Archivdatei	20130220
2	Importing	IV_COMMENTS	Call by reference	☐	Type reference (TYPE)	ADMI_TXT_F		Vermerk für eine Archivdatei	20130220

Method SET_FILE_COMMENTS on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method SET_RUN_COMMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMMENTS	Call by reference	☐	Type reference (TYPE)	ADMI_TEXT		Vermerk zum Archivierungslauf	20130220
2	Importing	IV_DOCUMENT	Call by reference	☐	Type reference (TYPE)	ADMI_RUN_D		Nummer eines Archivierungslaufs	20130220

Method SET_RUN_COMMENTS on class CL_ILM_ARC_CENTRAL_DATA has no exception.

Method SUBSTRACT_MONTHS_FROM_TODAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NUM_MONTH	Call by reference	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20130405
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	DATS		Feld vom Typ DATS	20130405

Method SUBSTRACT_MONTHS_FROM_TODAY on class CL_ILM_ARC_CENTRAL_DATA has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	740