SAP ABAP Interface IF_SA_DOC (Documents in SAP Solution Manager)

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 - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SA_DOC	Document in SAP Solution Manager	20010214
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SA_DOC_TEMPLATE	SAP Solution Architect Templates	20010302

Properties

Interface	IF_SA_DOC
Short Description	Documents in SAP Solution Manager

General Data

Package	SOLAR_DOC	Document Management in Solution Manager
Created	20010214	SAP
Last changed	20140121	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 IF_SA_DOC has no interface.

Friends

Interface IF_SA_DOC has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	A_DOC_STATUS	Instance attribute	Public	☑	Type reference (TYPE)	CHAR1		New/Opened/Closed	20010214
2	C_DOC_STATUS_CLOSED	Constant	Public	☐	Type reference (TYPE)	CHAR1	'C'	Document closed	20010214
3	C_DOC_STATUS_INITIAL	Constant	Public	☐	Type reference (TYPE)	CHAR1	'I'	Document is blank	20010214
4	C_DOC_STATUS_OPEN	Constant	Public	☐	Type reference (TYPE)	CHAR1	'O'	Document is open	20010214

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TO_TRKORR	Instance method	Public	Method	Inserts Document in Transport Request	20010410
2	CHECK_AND_SAVE	Instance method	Public	Method	Checks for Changes and Saves if Requested by User	20010215
3	CHECK_CHANGED	Instance method	Public	Method	Checks for Document Changes	20010215
4	CLOSE	Instance method	Public	Method	Closes Document (Document Can Be Opened Again)	20010215
5	DELETE	Instance method	Public	Method	Deletes Document from Knowledge Warehouse	20010306
6	DEQUEUE	Instance method	Public	Method	Unlock Info Object	20010313
7	DOWNLOAD	Instance method	Public	Method	Saves Document in Local File System	20010301
8	ENQUEUE	Instance method	Public	Method	Lock Info Object	20010313
9	FREE	Instance method	Public	Method	Deletes Control in Container	20010221
10	GET_FILE_EXT	Instance method	Public	Method	Provides File Type	20010323
11	GET_LOIO	Instance method	Public	Method	Returns Logical Info Object	20010410
12	GET_PREDECESSOR	Instance method	Public	Method	Returns Predecessor of Copied Documents	20010426
13	GET_PROPERTY	Instance method	Public	Method	Provides Property Value	20010301
14	GET_READONLY	Instance method	Public	Method	Provides Display Mode	20010313
15	GET_SLOIO	Instance method	Public	Method	Returns Structure for Logical Info Object	20010410
16	IS_DOC_OPEN_IN_EDITOR	Instance method	Public	Method	Was the document opened in the editor?	20040203
17	LAUNCH	Instance method	Public	Method	Do not use; open inplace document instead	20010228
18	OPEN_INPLACE	Instance method	Public	Method	Opens Inplace Document	20010215
19	PRINT	Instance method	Public	Method	Print Document	20060713
20	SAVE	Instance method	Public	Method	Saves Document in Knowledge Warehouse	20010215
21	SET_PROPERTY	Instance method	Public	Method	Sets Attribute	20010315
22	SET_READONLY_MODE_OFF	Instance method	Public	Method	Sets Change Mode	20010313
23	SET_READONLY_MODE_ON	Instance method	Public	Method	Sets Change Mode	20010313
24	SET_STATUS	Instance method	Public	Method	Sets Document Status	20010306
25	SET_TITLE	Instance method	Public	Method	Sets Document Title	20010228
26	SHOW_ATTR_DIALOG	Instance method	Public	Method	Display Attributes Dialog Box	20010315

Events

Interface IF_SA_DOC has no event.

Types

Interface IF_SA_DOC has no local type.

Method Signatures

Method ADD_TO_TRKORR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TRKORR	Call by reference	☐	Type reference (TYPE)	E070-TRKORR		Auftrag/Aufgabe	20010410

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

Method CHECK_AND_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_LOIO	Value transfer	☐	Type reference (TYPE)	SDOKOBJECT		LOIO des gesicherten Dokuments	20010220
2	Importing	I_TRKORR	Value transfer	☑	Type reference (TYPE)	E070-TRKORR		Auftrag/Aufgabe	20020708

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	User Abbruch	20010215
2	ERROR	☐	allg. Fehler	20010215
3	SAVED	☐	gesichert	20020805
4	SAVING_CANCELLED	☐		20081204

Method CHECK_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_IS_CHANGED	Value transfer	☐	Type reference (TYPE)	CHAR1		'X' = Dokument muß gesichert werden.	20010215

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

Method CLOSE Signature

Method CLOSE on Interface IF_SA_DOC has no parameter.

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

Method DELETE Signature

Method DELETE on Interface IF_SA_DOC has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCEL_DELETION	☐	Löschen abbrechen	20100223
2	ERROR	☐	allg. Fehler	20010306

Method DEQUEUE Signature

Method DEQUEUE on Interface IF_SA_DOC has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Fehler	20010313
2	NOT_SAVED	☐	die Daten sind noch nicht gesichert	20010313

Method DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		verwendeter Pfad und Dateiname	20010301
2	Importing	I_FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Dateiname (wenn leer dann GUID)	20010301
3	Importing	I_PATH	Call by reference	☑	Type reference (TYPE)	STRING		Pfad (wenn leer, dann TEMP)	20010301

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Fehler	20010301
2	EXTERNAL_URL	☐	Weblink	20020613
3	FILE_ERROR	☐	Fehler am Filesystem	20010301

Method ENQUEUE Signature

Method ENQUEUE on Interface IF_SA_DOC has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Fehler	20010313
2	FOREIGN_LOCK	☐	Sperren nicht möglich	20010313

Method FREE Signature

Method FREE on Interface IF_SA_DOC has no parameter.
Method FREE on Interface IF_SA_DOC has no exception.

Method GET_FILE_EXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_FILE_EXT	Value transfer	☐	Type reference (TYPE)	CHAR10		Characterfeld der Länge 10	20010323

Method GET_FILE_EXT on Interface IF_SA_DOC has no exception.

Method GET_LOIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_LOIO	Value transfer	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: BOR-Schlüssel für Informationsobjekt	20010410

Method GET_LOIO on Interface IF_SA_DOC has no exception.

Method GET_PREDECESSOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_PREDECESSOR	Value transfer	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: BOR-Schlüssel für Informationsobjekt	20010426

Method GET_PREDECESSOR on Interface IF_SA_DOC has no exception.

Method GET_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_VALUE	Value transfer	☐	Type reference (TYPE)	SDOKPROPTY-VALUE		Attributausprägung	20010301
2	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	SDOKPROPTY-NAME		Name des Attributs	20010301

Method GET_PROPERTY on Interface IF_SA_DOC has no exception.

Method GET_READONLY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_READONLY	Value transfer	☐	Type reference (TYPE)	CHAR1		'X' keine Änderungen erlaubt	20010313

Method GET_READONLY on Interface IF_SA_DOC has no exception.

Method GET_SLOIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_SLOIO	Value transfer	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: BOR-Schlüssel für Informationsobjekt	20010410

Method GET_SLOIO on Interface IF_SA_DOC has no exception.

Method IS_DOC_OPEN_IN_EDITOR Signature

Method IS_DOC_OPEN_IN_EDITOR on Interface IF_SA_DOC has no parameter.

#	Exception	Resumable	Description	Created on
1	DOC_IS_NOT_OPEN	☐		20040203

Method LAUNCH Signature

Method LAUNCH on Interface IF_SA_DOC has no parameter.
Method LAUNCH on Interface IF_SA_DOC has no exception.

Method OPEN_INPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☑	Type reference (TYPE)	SYUCOMM		Funktionscode	20130225
2	Importing	FULLSCREEN	Value transfer	☑	Type reference (TYPE)	CHAR1	SPACE	Einstelliges Kennzeichen	20011109
3	Importing	FULLSCREEN_E	Value transfer	☑	Type reference (TYPE)	CHAR1	SPACE	Einstelliges Kennzeichen	20011109
4	Importing	HANDLER_REF	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT			20011112
5	Importing	IS_PHYSICAL_OBJECT	Value transfer	☑	Type reference (TYPE)	SDOKOBJECT		explizit gewünschte PHIO	20030509
6	Importing	I_NO_HEADER	Value transfer	☑	Type reference (TYPE)	CHAR1	SPACE	Einstelliges Kennzeichen	20030207
7	Importing	ONLY_TITLE	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20011109

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	User Abbruch	20010215
2	DOCUMENT_IS_OPEN	☐	Dokument ist schon geöffnet	20010215
3	ERROR	☐	allg. Fehler	20010215
4	INPLACE_NOT_SUPPORTED	☐	Dokument kann nicht inplace geöffnet werden	20010308
5	NO_CONTAINER	☐	kein GUI Container vorhanden	20010314

Method PRINT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING			20061109
2	Importing	WITHOUT_SIGNATURE	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	Dokument ohne eventuelle Signaturen drucken	20061106

Method PRINT on Interface IF_SA_DOC has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_LOIO	Value transfer	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: Instanzen logischer Informationsobjekte	20010215
2	Importing	I_NO_CONTENT_CHECK	Call by reference	☑	Type reference (TYPE)	FLAG		Nur relevant für Officeintegration	20051103
3	Importing	I_TRKORR	Call by reference	☑	Type reference (TYPE)	E070-TRKORR		Auftrag/Aufgabe	20010410

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	User Abbruch	20010215
2	ERROR	☐	allg. Fehler	20010215

Method SET_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	SDOKPROPTY-NAME		Attributname	20010315
2	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	SDOKPROPTY-VALUE		Attributausprägung	20010315

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

Method SET_READONLY_MODE_OFF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NO_EDITOR_REFRESH	Call by reference	☑	Type reference (TYPE)	FLAG		Editor nicht neu laden	20050418
2	Importing	NO_REFRESH_FROM_DB	Call by reference	☑	Type reference (TYPE)	FLAG		Daten nicht neu lesen	20050418

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Fehler	20010313
2	FOREIGN_LOCK	☐	kein Sperren möglich	20010313

Method SET_READONLY_MODE_ON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FORCE	Call by reference	☑	Type reference (TYPE)	FLAG		Keine Prüfung, ob Daten sich geändert haben	20050316

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Fehler	20010313
2	NOT_SAVED	☐	kein Sperren möglich	20010313

Method SET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STATUS	Call by reference	☑	Type reference (TYPE)	IWIOPROPS-STATE		Status von Info-Objekten	20010306

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Error	20010306

Method SET_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TITLE	Call by reference	☑	Type reference (TYPE)	IWIOPROPS-TITLE		Titel	20010228

#	Exception	Resumable	Description	Created on
1	ERROR	☐	allg. Error	20010305

Method SHOW_ATTR_DIALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIV_TAB	Value transfer	☐	Type reference (TYPE)	SYUCOMM	SPACE		20040324
2	Importing	I_SHOW_SAVE_BUTTON	Value transfer	☑	Type reference (TYPE)	CHAR1	SPACE	SAVE- instead of ENTER-button	20030807

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	cancelled	20020819

History

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