SAP ABAP Interface I_OI_PIVOT (Pivot Table Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-FES-OFF (Application Component) SAP Desktop Office Integration
     ⤷ SOFFICEINTEGRATION (Package) Platform- and application-indep. Office integration

Properties

Interface	I_OI_PIVOT
Short Description	Pivot Table Interface

General Data

Package	SOFFICEINTEGRATION	Platform- and application-indep. Office integration
Created	19990407	SAP
Last changed	19991216	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SOI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface I_OI_PIVOT has no interface.

Friends

Interface I_OI_PIVOT has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	COLUMNFIELD	Constant	Public	☐	Type reference (TYPE)	I	2	Field is Column Field	19990409
2	DATAFIELD	Constant	Public	☐	Type reference (TYPE)	I	4	Field is Data Field	19990409
3	PAGEFIELD	Constant	Public	☐	Type reference (TYPE)	I	3	Entry as New Page	19990409
4	ROWFIELD	Constant	Public	☐	Type reference (TYPE)	I	1	Entry as New Line	19990409

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NEW_DATA	Instance method	Public	Method	Insert New Data	19990407
2	DRILL_DOWN	Instance method	Public	Method	Drilldown in Pivot Table	19990407
3	DRILL_UP	Instance method	Public	Method	Close a View	19990407
4	GET_ALLFIELDS	Instance method	Public	Method	Get all Entries	19990407
5	GET_ALLPIVOTTABLES	Instance method	Public	Method	Get Names of All Pivot Tables	19990407
6	INSERT_FULL	Instance method	Public	Method	Insert a Pivot Table	19990527
7	SET_FIELDTYPE	Instance method	Public	Method	Set Type of an Entry	19990409
8	SET_SOURCE_TABLE	Instance method	Public	Method	Set Data	19990407

Events

Interface I_OI_PIVOT has no event.

Types

Interface I_OI_PIVOT has no local type.

Method Signatures

Method ADD_NEW_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19990407
2	Importing	FORMULA	Call by reference	☐	Type reference (TYPE)	C		The formula of the new item	19990407
3	Importing	NAME	Call by reference	☐	Type reference (TYPE)	C		The name of the item	19990407
4	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	no_flush?	19990407
5	Importing	PIVOTTABLE	Call by reference	☐	Type reference (TYPE)	C		Name of pivottable	19990407
6	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19990407

Method ADD_NEW_DATA on Interface I_OI_PIVOT has no exception.

Method DRILL_DOWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19990407
2	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush	19990407
3	Importing	PIVOTTABLE	Call by reference	☐	Type reference (TYPE)	C		Name of pivottable	19990407
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19990407
5	Importing	ROW	Call by reference	☐	Type reference (TYPE)	C		Which row...	19990407
6	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	C		Which item in the row...	19990407

Method DRILL_DOWN on Interface I_OI_PIVOT has no exception.

Method DRILL_UP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19990407
2	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush?	19990407
3	Importing	PIVOTTABLE	Call by reference	☐	Type reference (TYPE)	C		Name of pivottable	19990407
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19990407
5	Importing	ROW	Call by reference	☐	Type reference (TYPE)	C		Which row...	19990407
6	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	C		Which item in the row...	19990407

Method DRILL_UP on Interface I_OI_PIVOT has no exception.

Method GET_ALLFIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ALLFIELDS	Call by reference	☐	Type reference (TYPE)	SOI_NAMETYPE_TABLE		Table of fields	19990409
2	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19990409
3	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush	19990407
4	Importing	PIVOTTABLE	Call by reference	☐	Type reference (TYPE)	C		Name of pivottable	19990409
5	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19990409

Method GET_ALLFIELDS on Interface I_OI_PIVOT has no exception.

Method GET_ALLPIVOTTABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ALLPIVOTTABLES	Call by reference	☐	Type reference (TYPE)	SOI_FIELDS_NAME_TABLE		Table of columnfields	19990407
2	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19990407
3	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush?	19990407
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19990407

Method GET_ALLPIVOTTABLES on Interface I_OI_PIVOT has no exception.

Method INSERT_FULL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA	Call by reference	☐	Type reference (TYPE)	TABLE		Daten	19990527
2	Importing	DATA_ENDING_AT	Call by reference	☐	Type reference (TYPE)	I	-1	Ende der Daten	19990527
3	Importing	DATA_STARTING_AT	Call by reference	☐	Type reference (TYPE)	I	1	Start der Daten	19990527
4	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		error?	19990527
5	Importing	FILENAME	Call by reference	☑	Type reference (TYPE)	C		Dateiname	19990611
6	Importing	HEADER_1	Call by reference	☑	Type reference (TYPE)	C		Titelzeile	19990611
7	Importing	HEADER_2	Call by reference	☑	Type reference (TYPE)	C		Untertitel	19990611
8	Importing	HKEY	Call by reference	☐	Type reference (TYPE)	SOI_HKEY_TABLE		Horizontale Einträge	19990527
9	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush?	19990527
10	Importing	N_ATT_COLS	Call by reference	☐	Type reference (TYPE)	I		Anzahl Datenspalten im Listobjekt	19990611
11	Importing	N_HRZ_KEYS	Call by reference	☐	Type reference (TYPE)	I		Anzahl H-Merkmale	19990611
12	Importing	N_VRT_KEYS	Call by reference	☐	Type reference (TYPE)	I		Anzahl V-Merkmale	19990611
13	Importing	ONLINE_TEXT	Call by reference	☐	Type reference (TYPE)	SOI_ONLINE_TABLE		Onlinetexte	19990601
14	Exporting	PIVOTNAME	Call by reference	☐	Type reference (TYPE)	C		Name der Pivottabelle	19990602
15	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of error?	19990527
16	Importing	SEMA	Call by reference	☐	Type reference (TYPE)	SOI_SEMA_TABLE		Semantik	19990527
17	Importing	SEMA_TYPE	Call by reference	☐	Type reference (TYPE)	C	''	Schalter für Stringkonvertierungen	19990611
18	Importing	VKEY	Call by reference	☐	Type reference (TYPE)	SOI_VKEY_TABLE		Vertikale Einträge	19990527

#	Exception	Resumable	Description	Created on
1	DIM_MISMATCH_DATA	☐	nicht vorhandene DATA-Spalte wird referenziert	19990611
2	DIM_MISMATCH_SEMA	☐	Anzahl SEMA-Zeilen <> N_VRT_KEYS + N_ATT_COLS	19990611
3	DIM_MISMATCH_VKEY	☐	Anzahl VKEY-Zeilen <> N_VRT_KEYS	19990611
4	ERROR_IN_HKEY	☐	siehe Dokumentation	19990611
5	ERROR_IN_SEMA	☐	Fehler in Semantikbeschreibung	19990622
6	ERROR_IN_VKEY	☐	siehe Dokumentation	19990611
7	INV_DATA_RANGE	☐	DATEN_VON / DATEN_BIS zu groß / zu klein	19990611

Method SET_FIELDTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONSOLIDATION	Call by reference	☐	Type reference (TYPE)	C		Verdichtung eines Pivotfeldes	19990602
2	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		error?	19990409
3	Importing	NAME	Call by reference	☐	Type reference (TYPE)	C		Name	19990409
4	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush?	19990409
5	Importing	PIVOT	Call by reference	☐	Type reference (TYPE)	C		Pivottable	19990412
6	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of error	19990409
7	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	I		Type	19990409

Method SET_FIELDTYPE on Interface I_OI_PIVOT has no exception.

Method SET_SOURCE_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA_TABLE	Call by reference	☐	Type reference (TYPE)	TABLE		Data	19990407
2	Importing	DDIC_NAME	Call by reference	☑	Type reference (TYPE)	X030L-TABNAME		Name of the table	19990407
3	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19990407
4	Importing	FIELDS_TABLE	Call by reference	☑	Type reference (TYPE)	SOI_FIELDS_TABLE		The fields of the table	19990407
5	Importing	ITEMS	Call by reference	☑	Type reference (TYPE)	SOI_NAMETYPE_TABLE		The items of row, column and data	19990407
6	Importing	ITEMSNR	Call by reference	☑	Type reference (TYPE)	SOI_COLTYPE_TABLE		The items of row, column and data	19990429
7	Importing	LENGTH	Call by reference	☑	Type reference (TYPE)	C		Length of text	19990429
8	Importing	NAME	Call by reference	☐	Type reference (TYPE)	C		The name of the Pivottable	19990407
9	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush?	19990407
10	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19990407

Method SET_SOURCE_TABLE on Interface I_OI_PIVOT has no exception.

History

Last changed by/on	SAP	19991216
SAP Release Created in