SAP ABAP Interface IF_RMPS_TRF_ASFS (Application Server File System API)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-GTF-RCM (Application Component) Records and Case Management
     ⤷ RMPS_DOD_TRF_RUNTIME (Package) DoD Transfer Run Time

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_RMPS_TRF_ASFS	Application Server File System (Abstract)	20090828

Properties

Interface	IF_RMPS_TRF_ASFS
Short Description	Application Server File System API

General Data

Package	RMPS_DOD_TRF_RUNTIME	DoD Transfer Run Time
Created	20090828	SAP
Last changed	20110908	SAP
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)

Interfaces

Interface IF_RMPS_TRF_ASFS has no interface.

Friends

Interface IF_RMPS_TRF_ASFS has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CSS	Constant	Public	☐	Type reference (TYPE)	STRING	'.css'	Extension .css	20091120
2	GC_DIR	Constant	Public	☐	Type reference (TYPE)	GTY_DIR_TYPE	'D'	Directory	20090828
3	GC_EXPORT_DIR	Constant	Public	☐	Type reference (TYPE)	PATHINTERN	'RMPS_TRF_EXPORT_DIR'	Logical path name to export directory	20091123
4	GC_EXPORT_DIR_STRUCTURE	Constant	Public	☐	Type reference (TYPE)	PATHINTERN	'RMPS_TRF_EXPORT_DIR_STRUCTURE'	Logical path name to structure of export directory	20091123
5	GC_FILE	Constant	Public	☐	Type reference (TYPE)	GTY_DIR_TYPE	'F'	File	20090828
6	GC_IMPORT_DIR	Constant	Public	☐	Type reference (TYPE)	PATHINTERN	'RMPS_TRF_IMPORT_DIR'	Logical path name to import directory	20091123
7	GC_XML	Constant	Public	☐	Type reference (TYPE)	STRING	'.xml'	Extension .xml	20091120
8	GC_XSD	Constant	Public	☐	Type reference (TYPE)	STRING	'.xsd'	Extension .xsd	20091120
9	GC_XSL	Constant	Public	☐	Type reference (TYPE)	STRING	'.xsl'	Extension .XSL	20091130

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_NAME	Instance method	Public	Method	Check characters in file/directory name	20091120
2	DELETE_FILE	Instance method	Public	Method	Delete file by absolute path	20090828
3	GET_DIR_SEPARATOR	Instance method	Public	Method	Get directory separator	20090828
4	GET_EXPORT_DIR	Instance method	Public	Method	Get absolute path to export directory	20091123
5	GET_EXPORT_DIR_STRUCTURE	Instance method	Public	Method	Get export directory structure as relative path	20091123
6	GET_IMPORT_DIR	Instance method	Public	Method	Get absolute path to import directory	20091123
7	GET_WDIR	Instance method	Public	Method	Get absolute path to working directory	20090828
8	INSERT_DIR_IN_WDIR	Instance method	Public	Method	Create new directory in working directory by relative path	20090828
9	INSERT_FILE_IN_WDIR	Instance method	Public	Method	Create new file in working directory by relative path	20090828
10	READ_DIR_CONTENTS	Instance method	Public	Method	List contents of directory by absolute path	20090828
11	READ_FILE	Instance method	Public	Method	Read file by absolute path	20090828
12	SET_WDIR	Instance method	Public	Method	Set working directory by absolute path	20090828
13	TRANSLATE_NAME	Instance method	Public	Method	Convert prohibited characters of file/directory name	20091120

Events

Interface IF_RMPS_TRF_ASFS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTY_DIR_TYPE	Public	See coding			20090828	gty_dir_type TYPE c LENGTH 1
2	GTY_S_DIR_CONTENTS	Public	See coding			20090828	BEGIN OF gty_s_dir_contents. TYPES type TYPE gty_dir_type. TYPES name TYPE string. TYPES absolute_path TYPE string. TYPES END OF gty_s_dir_contents
3	GTY_T_DIR_CONTENTS	Public	See coding			20090828	gty_t_dir_contents TYPE TABLE OF gty_s_dir_contents

Method Signatures

Method CHECK_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		File/directory name	20091120
2	Returning	RV_PROHIBITED_CHARS	Value transfer	☐	Type reference (TYPE)	STRING		Prohibited characters	20091120

Method CHECK_NAME on Interface IF_RMPS_TRF_ASFS has no exception.

Method DELETE_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ABSOLUTE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute path of file	20090828

#	Exception	Resumable	Description	Created on
1	CX_RMPS_TRF_ASFS	☐	Exception Accessing AS File System	20091118

Method GET_DIR_SEPARATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SEPARATOR	Value transfer	☐	Type reference (TYPE)	STRING		Directory separator	20090828

Method GET_DIR_SEPARATOR on Interface IF_RMPS_TRF_ASFS has no exception.

Method GET_EXPORT_DIR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ABSOLUTE_PATH	Value transfer	☐	Type reference (TYPE)	STRING		Absolute path to export directory	20091123

#	Exception	Resumable	Description	Created on
1	CX_RMPS_TRF_ASFS	☐	Exception Accessing AS File System	20091123

Method GET_EXPORT_DIR_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLASSIFICATION	Call by reference	☐	Type reference (TYPE)	RMPS_TRF_CLASSIFICATION	'SYSTEM'	Classification criterion (e.g. export destination)	20091123
2	Importing	IV_EXPORT_RUN_ID	Call by reference	☐	Type reference (TYPE)	RMPS_TRF_EX_ID		ID of an export run	20091123
3	Importing	IV_EXTERNAL_ENTITY	Call by reference	☐	Type reference (TYPE)	RMPS_TRF_EXTERNAL_ENTITY		External entity (XML root element)	20091123
4	Returning	RV_RELATIVE_PATH	Value transfer	☐	Type reference (TYPE)	STRING		Relative path of directory structure	20091123

#	Exception	Resumable	Description	Created on
1	CX_RMPS_TRF_ASFS	☐	Exception Accessing AS File System	20091123

Method GET_IMPORT_DIR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ABSOLUTE_PATH	Value transfer	☐	Type reference (TYPE)	STRING		Absolute path to import directory	20091123

#	Exception	Resumable	Description	Created on
1	CX_RMPS_TRF_ASFS	☐	Exception Accessing AS File System	20091123

Method GET_WDIR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ABSOLUTE_PATH	Value transfer	☐	Type reference (TYPE)	STRING		Absolute path to working directory	20091120

Method GET_WDIR on Interface IF_RMPS_TRF_ASFS has no exception.

Method INSERT_DIR_IN_WDIR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INTERMEDIATE_DIR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Creates any intermediate directories in the path, if needed	20090828
2	Importing	IV_RELATIVE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Relative path of directory	20090828
3	Returning	RV_ABSOLUTE_PATH	Value transfer	☐	Type reference (TYPE)	STRING		Absolute path of new directory	20091120

#	Exception	Resumable	Description	Created on
1	CX_RMPS_TRF_ASFS	☐	Exception Accessing AS File System	20091118

Method INSERT_FILE_IN_WDIR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		File content	20090828
2	Importing	IV_RELATIVE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Relative path of file	20090828
3	Returning	RV_ABSOLUTE_PATH	Value transfer	☐	Type reference (TYPE)	STRING		Absolute path to new file	20091120

#	Exception	Resumable	Description	Created on
1	CX_RMPS_TRF_ASFS	☐	Exception Accessing AS File System	20091118

Method READ_DIR_CONTENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONTENTS	Call by reference	☐	Type reference (TYPE)	GTY_T_DIR_CONTENTS		Contents of directory	20090828
2	Importing	IV_ABSOLUTE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute path to directory	20090828
3	Importing	IV_FILE_MASK	Call by reference	☐	Type reference (TYPE)	STRING	'*.*'	Mask for files	20090828
4	Importing	IV_LIST_DIRS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	List directories	20090828
5	Importing	IV_LIST_FILES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	List files	20090828

#	Exception	Resumable	Description	Created on
1	CX_RMPS_TRF_ASFS	☐	Exception Accessing AS File System	20091118

Method READ_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		File content	20090828
2	Importing	IV_ABSOLUTE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute path of file	20090828

#	Exception	Resumable	Description	Created on
1	CX_RMPS_TRF_ASFS	☐	Exception Accessing AS File System	20091118

Method SET_WDIR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ABSOLUTE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute path to working directory	20090828

Method SET_WDIR on Interface IF_RMPS_TRF_ASFS has no exception.

Method TRANSLATE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CHAR	Call by reference	☐	Type reference (TYPE)	STRING		Characters that got translated	20091120
2	Exporting	EV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Translated name	20091120
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Original name	20091120

Method TRANSLATE_NAME on Interface IF_RMPS_TRF_ASFS has no exception.

History

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