SAP ABAP Class CL_UC_FILE (File Interface)

Hierarchy

☛ SEM-BW (Software Component) SEM-BW: Strategic Enterprise Management
   ⤷ FIN-SEM-BCS (Application Component) Business Consolidation
     ⤷ UCF7 (Package) SEM-BCS: Flexible Upload

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_UG_WB_COMMUNICATION	Workbench: Events and Methods for Communication with the WB	20041105

Properties

Class	CL_UC_FILE
Short Description	File Interface
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	UCF7	SEM-BCS: Flexible Upload
Created	20010616	SAP
Last change	20041209	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_GUI_FRONTEND_SERVICES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	UCF7	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_UG_WB_COMMUNICATION	☐	☐	Workbench: Events and Methods for Communication with the WB	20041105

Friends

Class CL_UC_FILE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DD_CURSOR	Instance attribute	Private	☐	Type reference (TYPE)	I		Cursor on File Row	20010616
2	DD_FORMAT	Instance attribute	Public	☑	Type reference (TYPE)	UC_FILEFORMAT		File Format	20010616
3	DD_LINECOUNT	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Lines	20010617
4	DD_LOCATION	Instance attribute	Public	☑	Type reference (TYPE)	UC_FILELOCATION		File storage	20010616
5	DD_NAME	Instance attribute	Public	☑	Type reference (TYPE)	UC_FILENAME		File Name	20010616
6	DT_LINE	Instance attribute	Private	☐	Type reference (TYPE)	UCF_T_FILELINE		File Rows	20010616
7	DT_LINE_WD	Static Attribute	Private	☐	Type reference (TYPE)	T_LINE_WD			20041108
8	GC_LOGFILE_PARAM1	Constant	Private	☐	Type reference (TYPE)	FILEEXTERN	''	Physical File Name	20021128
9	GC_LOGFILE_PARAM2	Constant	Private	☐	Type reference (TYPE)	FILEEXTERN	''	Physical File Name	20021128
10	GC_LOGFILE_PARAM3	Constant	Private	☐	Type reference (TYPE)	FILEEXTERN	''	Physical File Name	20021128
11	GC_TRUE	Constant	Private	☐	Type reference (TYPE)	UC_FLG	'X'	TRUE	20010616

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20010616
2	EXPORT	Instance method	Public	Method		20010616
3	FILE_EXIST	Instance method	Private	Method		20010726
4	FREE	Instance method	Public	Method		20021216
5	GET_LINE	Instance method	Public	Method		20010616
6	GET_NEXT_LINE	Instance method	Public	Method		20010616
7	IMPORT	Instance method	Public	Method		20010616
8	IS_END_OF_FILE	Instance method	Public	Method		20010616
9	IS_REQUIRED_PARAMETER	Static method	Public	Method		20021128
10	RESET_CURSOR	Instance method	Public	Method		20010616
11	RESET_LINECOUNT	Instance method	Private	Method		20010616
12	SET_FILE	Instance method	Public	Method		20010616
13	SET_FILE_LOGICAL	Instance method	Public	Method		20010616
14	SET_LINES	Instance method	Public	Method		20010616
15	WD_SET_FILE_CONTENT	Static method	Public	Method		20041108

Events

Class CL_UC_FILE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_LINE_WD	Private	See coding			20041108	begin of S_LINE_WD, filename type uc_filename, t_line type UCF_T_FILELINE, end of s_line_wd
2	T_LINE_WD	Private	See coding			20041108	T_LINE_WD type sorted table of S_LINE_WD with unique key filename

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_FORMAT	Call by reference	☐	Type reference (TYPE)	UC_FILEFORMAT	UCF7_C_FILEFORMAT-TXT	Dateiformat	20010616
2	Importing	ID_LOCATION	Call by reference	☐	Type reference (TYPE)	UC_FILELOCATION	UCF7_C_FILELOCATION-PRESSERV	Dateiablage	20010616
3	Importing	ID_LOGFILE	Call by reference	☑	Type reference (TYPE)	UC_LOGFILE		Logischer Dateiname	20010616
4	Importing	ID_NAME	Call by reference	☑	Type reference (TYPE)	UC_FILENAME		Dateiname	20010616
5	Importing	ID_PARAM1	Call by reference	☑	Type reference (TYPE)	DATA			20010726
6	Importing	ID_PARAM2	Call by reference	☑	Type reference (TYPE)	DATA			20010726
7	Importing	ID_PARAM3	Call by reference	☑	Type reference (TYPE)	DATA			20021128

Method CONSTRUCTOR on class CL_UC_FILE has no exception.

Method EXPORT Signature

Method EXPORT on class CL_UC_FILE has no parameter.
Method EXPORT on class CL_UC_FILE has no exception.

Method FILE_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EF_EXIST	Value transfer	☐	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20010726

#	Exception	Resumable	Description	Created on
1	NOT_SUPPORTED_BY_GUI	☐		20020419

Method FREE Signature

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

Method GET_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_LINE	Call by reference	☐	Type reference (TYPE)	UC_FILELINE		Dateizeile	20010616
2	Importing	ID_ROW	Call by reference	☑	Type reference (TYPE)	I			20010616

Method GET_LINE on class CL_UC_FILE has no exception.

Method GET_NEXT_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_LINE	Call by reference	☐	Type reference (TYPE)	UC_FILELINE		Dateizeile	20010616
2	Exporting	ED_LINECOUNT	Call by reference	☐	Type reference (TYPE)	UC_LINECOUNT		Zeilennummer	20010617

Method GET_NEXT_LINE on class CL_UC_FILE has no exception.

Method IMPORT Signature

Method IMPORT on class CL_UC_FILE has no parameter.

#	Exception	Resumable	Description	Created on
1	FAILURE	☐		20010616

Method IS_END_OF_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EF_EOF	Value transfer	☐	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20010616

Method IS_END_OF_FILE on class CL_UC_FILE has no exception.

Method IS_REQUIRED_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_PARAM1	Call by reference	☐	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20021128
2	Exporting	EF_PARAM2	Call by reference	☐	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20021128
3	Exporting	EF_PARAM3	Call by reference	☐	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20021128
4	Importing	ID_LOGFILE	Call by reference	☐	Type reference (TYPE)	UC_LOGFILE		Logischer Dateiname	20021128

Method IS_REQUIRED_PARAMETER on class CL_UC_FILE has no exception.

Method RESET_CURSOR Signature

Method RESET_CURSOR on class CL_UC_FILE has no parameter.
Method RESET_CURSOR on class CL_UC_FILE has no exception.

Method RESET_LINECOUNT Signature

Method RESET_LINECOUNT on class CL_UC_FILE has no parameter.
Method RESET_LINECOUNT on class CL_UC_FILE has no exception.

Method SET_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_FORMAT	Call by reference	☐	Type reference (TYPE)	UC_FILEFORMAT	UCF7_C_FILEFORMAT-TXT	Dateiformat	20010616
2	Importing	ID_LOCATION	Call by reference	☐	Type reference (TYPE)	UC_FILELOCATION	UCF7_C_FILELOCATION-PRESSERV	Dateiablage	20010616
3	Importing	ID_NAME	Call by reference	☐	Type reference (TYPE)	UC_FILENAME		Dateiname	20010616

#	Exception	Resumable	Description	Created on
1	FILE_NOT_FOUND	☐		20010616

Method SET_FILE_LOGICAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_LOCATION	Call by reference	☐	Type reference (TYPE)	UC_FILELOCATION	UCF7_C_FILELOCATION-PRESSERV	Dateiablage	20010616
2	Importing	ID_LOGFILE	Call by reference	☐	Type reference (TYPE)	UC_LOGFILE		Logischer Dateiname	20010616
3	Importing	ID_PARAM1	Call by reference	☑	Type reference (TYPE)	DATA			20010726
4	Importing	ID_PARAM2	Call by reference	☑	Type reference (TYPE)	DATA			20010726
5	Importing	ID_PARAM3	Call by reference	☑	Type reference (TYPE)	DATA			20021128

#	Exception	Resumable	Description	Created on
1	FILEFORMAT_UNKNOWN	☐		20010616
2	FILE_NOT_FOUND	☐		20010616
3	PHYSICAL_PATH_NOT_FOUND	☐		20010616

Method SET_LINES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LINE	Call by reference	☐	Type reference (TYPE)	UCF_T_FILELINE		Dateizeilen	20010616

Method SET_LINES on class CL_UC_FILE has no exception.

Method WD_SET_FILE_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_FILEDATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20041108
2	Importing	ID_FILENAME	Call by reference	☐	Type reference (TYPE)	UC_FILENAME		Dateiname	20041108

Method WD_SET_FILE_CONTENT on class CL_UC_FILE has no exception.

History

Last changed by/on	SAP	20041209
SAP Release Created in	3.1A