SAP ABAP Interface IF_FDT_DOC_SPREADSHEET (FDT: Spreadsheet Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
     ⤷ SFDT_EXCEL_CORE (Package) BRFplus: Excel Integration Core

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_FDT_XL_SPREADSHEET	FDT:Spreadsheet document	20080616

Properties

Interface	IF_FDT_DOC_SPREADSHEET
Short Description	FDT: Spreadsheet Interface

General Data

Package	SFDT_EXCEL_CORE	BRFplus: Excel Integration Core
Created	20080616	SAP
Last changed	20140121	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)
2	IF_FDT_DOC_SPREADSHEET	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FDT_DOC_PKG	☐	☐	Basic access to document packages	20080616

Friends

Interface IF_FDT_DOC_SPREADSHEET has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DEFAULT_FILENAME	Constant	Public	☐	Type reference (TYPE)	STRING	'EXPORT.XLSX'		20080725
2	GC_CALL_DEC_TABLE	Constant	Public	☐	Type reference (TYPE)	I	1	Decision Table	20111214
3	GC_CALL_MESSAGE_AREA	Constant	Public	☐	Type reference (TYPE)	I	2	Message Area	20111214
4	GC_CALL_NEW_LEAN_TRACE	Constant	Public	☐	Type reference (TYPE)	I	5	Trace	20130516
5	GC_CALL_SIMULATION	Constant	Public	☐	Type reference (TYPE)	I	3	Simulation	20111214
6	GC_CALL_TRACE	Constant	Public	☐	Type reference (TYPE)	I	4	Trace	20111214

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_DOCUMENT	Static method	Public	Method		20080616
2	GET_CUSTOM_METADATA	Instance method	Public	Method		20080616
3	GET_ITAB_FOR_ALV_UPDATE	Instance method	Public	Method		20080616
4	GET_ITAB_FROM_WORKSHEET	Instance method	Public	Method		20080616
5	GET_MAPPING	Instance method	Public	Method		20080616
6	GET_NAMED_CELLS	Instance method	Public	Method		20080616
7	GET_NAMED_CELL_VALUE	Instance method	Public	Method		20080616
8	GET_NAMED_RANGES	Instance method	Public	Method		20080616
9	GET_NAMED_RANGE_ITAB	Instance method	Public	Method		20080616
10	GET_WORKSHEET_NAMES	Instance method	Public	Method		20080616
11	SET_CUSTOM_METADATA	Instance method	Public	Method		20080616
12	SET_MAPPING	Instance method	Public	Method		20080616
13	SET_NAMED_CELL_VALUE	Instance method	Public	Method		20080616
14	SET_NAMED_RANGE_VALUES	Instance method	Public	Method		20080616

Events

Interface IF_FDT_DOC_SPREADSHEET has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	STRUC_NAMED_CELL	Public	See coding			20080616	BEGIN OF struc_named_cell, name TYPE string, sheet_name TYPE string, cell TYPE string, format TYPE string, END OF struc_named_cell
2	STRUC_NAMED_RANGE	Public	See coding			20080616	BEGIN OF struc_named_range, name TYPE string, sheet_name TYPE string, start_cell TYPE string, end_cell TYPE string, END OF struc_named_range
3	S_COLUMN	Public	See coding			20081224	BEGIN OF s_column, id TYPE fdt_uuid, name TYPE string, display_name TYPE string, is_result TYPE abap_bool, type TYPE REF TO cl_abap_datadescr, END OF s_column
4	TAB_NAMED_CELLS	Public	See coding			20080616	tab_named_cells TYPE STANDARD TABLE OF struc_named_cell
5	TAB_NAMED_RANGES	Public	See coding			20080616	tab_named_ranges TYPE STANDARD TABLE OF struc_named_range
6	T_COLUMN	Public	See coding			20081224	t_column TYPE STANDARD TABLE OF s_column
7	T_WORKSHEET_NAMES	Public	See coding			20080616	t_worksheet_names TYPE STANDARD TABLE OF string

Method Signatures

Method CREATE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLUMNS	Call by reference	☑	Type reference (TYPE)	IF_FDT_DOC_SPREADSHEET=>T_COLUMN			20081224
2	Importing	COLUMNS_AUX	Call by reference	☑	Type reference (TYPE)	IF_FDT_DOC_SPREADSHEET=>T_COLUMN		Excel sheet column for Decision table/Mapping column	20120608
3	Importing	ITAB	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20080616
4	Importing	ITAB_AUX_COL_DESC	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Decision Table /Mapping Column Description	20120608
5	Importing	IT_DT_MAP_COL	Call by reference	☑	Type reference (TYPE)	IF_FDT_DOC_SPREADSHEET=>T_COLUMN			20120709
6	Importing	IT_DT_MAP_COL_DESC	Call by reference	☑	Object reference (TYPE REF TO)	DATA			20120709
7	Importing	IV_CALL_TYPE	Call by reference	☐	Type reference (TYPE)	I		Calling Application	20111214
8	Importing	IV_SHEET_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20130425
9	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING	DEFAULT_FILENAME		20080616
10	Returning	XDOCUMENT	Value transfer	☐	Type reference (TYPE)	XSTRING			20080616

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL_CORE	☐		20080616

Method GET_CUSTOM_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080616
2	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20080616

Method GET_CUSTOM_METADATA on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method GET_ITAB_FOR_ALV_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ITAB	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20080616

Method GET_ITAB_FOR_ALV_UPDATE on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method GET_ITAB_FROM_WORKSHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ITAB	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20080616
2	Importing	IV_CALLER	Call by reference	☑	Type reference (TYPE)	I			20130430
3	Importing	IV_GET_LANGUAGE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20130430
4	Importing	WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080616

Method GET_ITAB_FROM_WORKSHEET on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method GET_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MAPPING	Value transfer	☐	Object reference (TYPE REF TO)	CL_FDT_DOC_MAPPING			20080616

Method GET_MAPPING on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method GET_NAMED_CELLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NAMED_CELLS	Value transfer	☐	Type reference (TYPE)	TAB_NAMED_CELLS			20080616

Method GET_NAMED_CELLS on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method GET_NAMED_CELL_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CELL_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080616
2	Returning	CELL_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20080616

Method GET_NAMED_CELL_VALUE on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method GET_NAMED_RANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NAMED_RANGES	Value transfer	☐	Type reference (TYPE)	TAB_NAMED_RANGES			20080616

Method GET_NAMED_RANGES on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method GET_NAMED_RANGE_ITAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ITAB	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20080616
2	Importing	RANGE	Call by reference	☐	Type reference (TYPE)	STRING			20080616

Method GET_NAMED_RANGE_ITAB on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method GET_WORKSHEET_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	WORKSHEET_NAMES	Value transfer	☐	Type reference (TYPE)	T_WORKSHEET_NAMES			20080616

Method GET_WORKSHEET_NAMES on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method SET_CUSTOM_METADATA Signature

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

Method SET_CUSTOM_METADATA on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method SET_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MAPPING	Call by reference	☐	Object reference (TYPE REF TO)	CL_FDT_DOC_MAPPING			20080616

Method SET_MAPPING on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method SET_NAMED_CELL_VALUE Signature

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

Method SET_NAMED_CELL_VALUE on Interface IF_FDT_DOC_SPREADSHEET has no exception.

Method SET_NAMED_RANGE_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITAB	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20080616
2	Importing	RANGE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080616

Method SET_NAMED_RANGE_VALUES on Interface IF_FDT_DOC_SPREADSHEET has no exception.

History

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