SAP ABAP Class CL_ILM_FILE (Archiving File)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-ADK (Application Component) Archive Development Kit
     ⤷ S_ILM_ARC_ADMIN (Package) Archive Administration Back-End

Properties

Class	CL_ILM_FILE
Short Description	Archiving File
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ILM_ARC_ADMIN	Archive Administration Back-End
Created	20130116	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ILM_FILE has no forward declaration.

Interfaces

Class CL_ILM_FILE has no interface implemented.

Friends

Class CL_ILM_FILE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MS_ADMI_FILES	Instance attribute	Private	☐	Type reference (TYPE)	ADMI_FILES		Archive Files of Archive Sessions	20130121
2	MV_FILE	Instance attribute	Private	☐	Type reference (TYPE)	ARKEY		Key for Archive File	20130116
3	MV_ILM_USAGE	Static Attribute	Private	☐	Type reference (TYPE)	BOOLE_D		Data Element for BOOLE Domain: TRUE (='X') and FALSE (=' ')	20130121
4	MV_SESSION	Instance attribute	Private	☐	Type reference (TYPE)	ADMI_RUN_D		Archiving Session Number	20130116

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20130121
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130121
3	GET_EXTENDED_FILE_DETAILS	Instance method	Public	Method	Gets Extended Information for a File	20130117
4	GET_RETENTION_DATES	Static method	Private	Method	Gets Expiration Date and Data Destruction Date	20130117
5	SET_COMMENT	Static method	Public	Method	Persists Comment Pertaining to a File	20130206

Events

Class CL_ILM_FILE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_ACCESS_STATUS	Public	See coding		Structure of Text and Icons for Archiving File Accessiblilty	20130117	BEGIN OF ty_s_access_status, status_txt TYPE val_text, status_img TYPE string, END OF ty_s_access_status
2	TY_S_FILE_DETAILS	Public	See coding			20130121	BEGIN OF ty_s_file_details, admi_files TYPE admi_files, filesize TYPE ilm_filesize, access_status TYPE cl_ilm_file=>ty_s_access_status, physfile TYPE admi_file, admi_file_davlnk TYPE admi_file_davlnk, name_del_job TYPE btcjob, name_sto_job TYPE btcjob, name_ret_job TYPE btcjob, storage_location(20) TYPE c, expiration_date TYPE arch_rout_expiration_date, expiration_unknown TYPE boole_d, max_retention_date TYPE admi_max_retention_date, max_retention_unknown TYPE boole_d, stored_with_webdav(1) TYPE c, t_legalhold_cases TYPE cl_arc_das_con=>tt_ilm_cases, invalid TYPE boole_d, END OF ty_s_file_details

Method Signatures

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_ILM_FILE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ILM_FILE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ADMI_FILES	Call by reference	☑	Type reference (TYPE)	ADMI_FILES		Archivdateien der Archivierungsläufe	20130121
2	Importing	IV_FILE	Call by reference	☐	Type reference (TYPE)	ARKEY		Schlüssel einer Archivdatei	20130121

Method CONSTRUCTOR on class CL_ILM_FILE has no exception.

Method GET_EXTENDED_FILE_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_FILE_DETAILS	Value transfer	☐	Type reference (TYPE)	TY_S_FILE_DETAILS			20130121

Method GET_EXTENDED_FILE_DETAILS on class CL_ILM_FILE has no exception.

Method GET_RETENTION_DATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_EXPIRATION_DATE	Call by reference	☐	Type reference (TYPE)	ARCH_ROUT_EXPIRATION_DATE		Ablaufdatum einer Kollektion/Resource	20130117
2	Exporting	EV_EXPIRATION_DATE_UNKNOWN	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Datum nicht bekannt	20130118
3	Exporting	EV_MAX_RETENTION_DATE	Call by reference	☐	Type reference (TYPE)	ADMI_MAX_RETENTION_DATE		Obligatorisches Vernichtungsdatum einer Kollektion/Resource	20130117
4	Exporting	EV_MAX_RETENTION_DATE_UNKNOWN	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Datum nicht bekannt	20130118
5	Importing	IV_ARCHIVING_OBJECT	Call by reference	☐	Type reference (TYPE)	OBJCT_TR01		Archivierungsobjekt	20130117
6	Importing	IV_URI	Call by reference	☐	Type reference (TYPE)	ADMI_URI_ADK		URI einer Ressource oder Kollektion	20130117
7	Importing	IV_WEBDAV_DEST	Call by reference	☐	Type reference (TYPE)	ADMI_WEBDAV_DESTINATION		HTTP-Verbindung zum XML-DAS für WebDAV	20130117

Method GET_RETENTION_DATES on class CL_ILM_FILE has no exception.

Method SET_COMMENT Signature

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

Method SET_COMMENT on class CL_ILM_FILE has no exception.

History

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