SAP ABAP Class CL_SA_DOC_OI (Office Integration Document in SAP Solution Architect)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ SV-SMG-IMP (Application Component) Solution Manager Implementation
     ⤷ SOLAR_DOC (Package) Document Management in Solution Manager

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SA_DOC	Document in SAP Solution Manager	20010214

Properties

Class	CL_SA_DOC_OI
Short Description	Office Integration Document in SAP Solution Architect
Super Class	CL_SA_DOC	Document in SAP Solution Manager
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOLAR_DOC	Document Management in Solution Manager
Created	20010213	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_SA_DOC_OI has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SA_DOC_FACTORY	☐	20010314	SAP Solution Manager: Document Management

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AT_CONTAINER	Static Attribute	Private	☐	Type reference (TYPE)	TY_CONTAINER_T		Screen Container with Office Integration Containers	20010314
2	AT_REG_DOC_TYPES	Static Attribute	Private	☐	Type reference (TYPE)	SOI_DOCUMENT_TYPE_DESCR_LIST		Document Types Registered in Front End	20010214
3	A_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	OBJECT			20011109
4	R_OI_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_CONTAINER_CONTROL		Document Container Control Interface	20010318
5	R_OI_DOCUMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_DOCUMENT_PROXY		Document in Office Integration	20010220

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_SUPPORTED	Static method	Public	Method	Checks Document Format for Office Integration Compatibility	20010228
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20010214
3	GET_OI_CONTAINER	Static method	Private	Method	Supplies GUI Container with Office Integration Container	20010314
4	ON_DOCUMENT_CLOSE	Instance method	Private	Event handling method		20011109
5	RAISE_OI_ERROR	Static method	Private	Method	Triggers Error Message from Office Integration	20010214

Events

Class CL_SA_DOC_OI has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_CONTAINER	Private	See coding			20010314	begin of TY_CONTAINER . types r_oi_container type ref to i_oi_container_control. types r_editor_container type ref to cl_gui_container. types end of TY_CONTAINER
2	TY_CONTAINER_T	Private	See coding			20010314	TY_CONTAINER_T type hashed table of ty_container with unique key r_editor_container

Method Signatures

Method CHECK_SUPPORTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DOCUMENT_TYPE	Call by reference	☐	Type reference (TYPE)	SOI_DOCUMENT_TYPE		Programm zur Dateiendung	20010228
2	Exporting	E_IS_SUPPORTED	Value transfer	☐	Type reference (TYPE)	CHAR1		'X' = wird unterstützt	20010228
3	Importing	I_FORMAT	Call by reference	☐	Type reference (TYPE)	CHAR10		Dateieindung	20010228

Method CHECK_SUPPORTED on class CL_SA_DOC_OI has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method GET_OI_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_OI_CONTAINER	Value transfer	☐	Object reference (TYPE REF TO)	I_OI_CONTAINER_CONTROL		OI Container	20010314
2	Importing	I_PARENT_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20010314
3	Importing	I_SHOW_TOOLBARS	Call by reference	☑	Type reference (TYPE)	CHAR1	SPACE	Toolbars im Editor anzeigen	20010314

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Fehler	20010314

Method ON_DOCUMENT_CLOSE Signature

Method ON_DOCUMENT_CLOSE on class CL_SA_DOC_OI has no parameter.
Method ON_DOCUMENT_CLOSE on class CL_SA_DOC_OI has no exception.

Method RAISE_OI_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OI_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		Fehler-Objekt	20010214

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Fehler	20010214

History

Last changed by/on	SAP	20130531
SAP Release Created in	610