SAP ABAP Interface IF_MR_API (API for MIME Repository - Basic Functions)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO (Application Component) Workbench Tools: Editors, Painters, Modelers
     ⤷ SMIM_API (Package) MIME Repository - API

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_MIME_REPOSITORY_API	API for MIME Repository	20030430

Properties

Interface	IF_MR_API
Short Description	API for MIME Repository - Basic Functions

General Data

Package	SMIM_API	MIME Repository - API
Created	20030430	SAP
Last changed	20140121	SAP
Unicode checks active	☑

Forward declarations

Interface IF_MR_API has no forward declaration.

Interfaces

Interface IF_MR_API has no interface.

Friends

Interface IF_MR_API has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_VIRUS_PROFILE	Constant	Public	☐	Type reference (TYPE)	VSCAN_PROFILE	'/SMIM_API/PUT'		20120418

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_FOLDER	Instance method	Public	Method	Create Folder in MIME Repository	20030430
2	DELETE	Instance method	Public	Method	Delete MIME Object in the MIME Repository	20030522
3	FILE_LIST	Instance method	Public	Method	Supply All Files of a Folder in the MIME Repository	20030526
4	GET	Instance method	Public	Method	Supply Contents of a MIME Object	20030430
5	GET_API	Static method	Public	Method	Create API Instance	20030430
6	GET_BY_IO	Instance method	Public	Method	Supply Contents of a MIME Object	20110510
7	GET_IO_FOR_URL	Instance method	Public	Method	Supply Kpro Object (LOIO) Based on URL Address	20031007
8	GET_URL_FOR_IO	Instance method	Public	Method	Supply URL Address on Kpro Object (LOIO)	20110510
9	PROPERTIES	Instance method	Public	Method	Supply Properties of a MIME Object	20030603
10	PUT	Instance method	Public	Method	Create or Overwrite MIME Object in the MIME Repository	20030430

Events

Interface IF_MR_API has no event.

Types

Interface IF_MR_API has no local type.

Method Signatures

Method CREATE_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FOLDER_IO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		Ordner-IO (Technischer Objektschlüssel inkl. GUID)	20030520
2	Importing	I_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	'X'	X-Berechtigung prüfen, ''-keine Berechtigungsprüfung	20030513
3	Importing	I_CORR_NUMBER	Call by reference	☑	Type reference (TYPE)	TRKORR		Auftrag/Aufgabe	20030513
4	Importing	I_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		Ordner-Kurzbeschreibung	20030519
5	Importing	I_DEV_PACKAGE	Call by reference	☑	Type reference (TYPE)	DEVCLASS		Paket (initial->Dialog/Vaterpaket übernehmen)	20030513
6	Importing	I_FOLDER_LOIO	Call by reference	☑	Type reference (TYPE)	SKWF_IO		Eindeutige Ordner-Id, wenn vorgegeben	20030909
7	Importing	I_FOLDER_ROLE	Call by reference	☐	Type reference (TYPE)	MR_FROLE	SPACE	Ordnerrolle, wenn vorgegeben	20031203
8	Importing	I_GENFLAG	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE		20130207
9	Importing	I_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Originalsprache in TADIR	20030514
10	Importing	I_NEW_FOLDER_ROLE_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	DDTEXT	SPACE	Kurztext für eine neue Ordnerrolle	20031203
11	Importing	I_SUPPRESS_DIALOGS	Call by reference	☑	Type reference (TYPE)	BOOLE_D		X-Dialoge werden unterdrückt	20100312
12	Importing	I_SUPPRESS_PACKAGE_DIALOG	Call by reference	☐	Type reference (TYPE)	BOOLE_D	SPACE	X-Paketabfrage unterdrücken	20030519
13	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Ordner-URL	20030513

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	Aktion wurde abgebrochen	20030513
2	ERROR_OCCURED	☐	Unspezifischer Fehler aufgetreten	20030513
3	FOLDER_EXISTS	☐	Ordner existiert bereits	20030519
4	PARAMETER_MISSING	☐	Parameter fehlt oder ist initial	20030513
5	PERMISSION_FAILURE	☐	fehlende Berechtigung	20030513

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	'X'	X-Berechtigung prüfen, ''-keine Berechtigungsprüfung	20030522
2	Importing	I_CORR_NUMBER	Call by reference	☑	Type reference (TYPE)	TRKORR		Auftrag/Aufgabe	20030522
3	Importing	I_DELETE_CHILDREN	Call by reference	☐	Type reference (TYPE)	BOOLE_D	''	X-alle Kinder löschen, ''-Abbruch, wenn Kinder vorhanden	20030526
4	Importing	I_SUPPRESS_DIALOGS	Call by reference	☑	Type reference (TYPE)	BOOLE_D			20130220
5	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Objekt-URL	20030522

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	Aktion wurde abgebrochen	20030522
2	ERROR_OCCURED	☐	Unspezifischer Fehler aufgetreten	20030522
3	NOT_FOUND	☐	Objekt nicht gefunden	20030522
4	PARAMETER_MISSING	☐	Parameter fehlt oder ist initial	20030522
5	PERMISSION_FAILURE	☐	fehlende Berechtigung	20030522

Method FILE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FILES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Alle Dateien des Ordners	20030526
2	Importing	I_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	'X'	X-Berechtigung zur Anzeige prüfen	20030526
3	Importing	I_RECURSIVE_CALL	Call by reference	☐	Type reference (TYPE)	BOOLE_D	''	X-auch Dateien in Unterordner liefern	20030603
4	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Ordner-URL	20030526

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	Unspezifischer Fehler aufgetreten	20030526
2	IS_NOT_FOLDER	☐	Objekt ist kein Ordner	20030526
3	NOT_FOUND	☐	Objekt nicht gefunden	20030526
4	PARAMETER_MISSING	☐	Parameter fehlt oder ist initial	20030526
5	PERMISSION_FAILURE	☐	fehlende Berechtigung	20030526

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LANGU		Sprache des Objektes	20030513
2	Exporting	E_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Objekt-Inhalt	20030513
3	Exporting	E_CONTENT_LAST_CHANGED	Call by reference	☐	Type reference (TYPE)	SMIMPHIO-CHNG_TIME		Änderungszeitpunkt (UTC) des Inhalts	20031119
4	Exporting	E_IS_FOLDER	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X-Objekt ist Ordner, ''-sonst Datei	20030604
5	Exporting	E_LOIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		Technischer Objektschlüssel inkl. MIME-GUID	20030909
6	Exporting	E_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		MIME-Typ	20030513
7	Importing	I_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	'X'	X-Berechtigung prüfen, ''-keine Berechtigungsprüfung	20030513
8	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Objekt-URL	20030513

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	Unspezifischer Fehler aufgetreten	20030513
2	NOT_FOUND	☐	Objekt nicht gefunden	20030513
3	PARAMETER_MISSING	☐	Parameter fehlt oder ist initial	20030513
4	PERMISSION_FAILURE	☐	fehlende Berechtigung	20030513

Method GET_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PREFIX	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	SPACE	Präfix für API - nur wegen Verwendung von relativen Pfaden!	20030911
2	Returning	R_MR_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_MR_API		MIME Repository API	20030430

Method GET_API on Interface IF_MR_API has no exception.

Method GET_BY_IO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LANGU		Object Language	20110510
2	Exporting	E_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Object Contents	20110510
3	Exporting	E_CONTENT_LAST_CHANGED	Call by reference	☐	Type reference (TYPE)	SMIMPHIO-CHNG_TIME		Change Time (UTC) of Content	20110510
4	Exporting	E_IS_FOLDER	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X - Object is folder, '' - Otherwise file	20110510
5	Exporting	E_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		MIME Type	20110510
6	Importing	I_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	'X'	X Check Authorization, '' No Authorization Check	20110510
7	Importing	I_LOIO	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID		GUID	20110510

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	Unspecified Error Occurred	20110510
2	NOT_FOUND	☐	Object Not Found	20110510
3	PARAMETER_MISSING	☐	Parameter missing or is initial	20110510
4	PERMISSION_FAILURE	☐	Missing Authorization	20110510

Method GET_IO_FOR_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_IS_FOLDER	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X-Objekt ist Ordner, ''-sonst Datei	20031007
2	Exporting	E_LOIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		Logisches Dokument in KPro	20031007
3	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Objekt-URL	20031007

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	Unspezifischer Fehler aufgetreten	20031007
2	NOT_FOUND	☐	Objekt nicht gefunden	20031007
3	PARAMETER_MISSING	☐	Parameter fehlt oder ist initial	20031007

Method GET_URL_FOR_IO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_IS_FOLDER	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X - Object is folder, '' - Otherwise file	20110510
2	Exporting	E_URL	Call by reference	☐	Type reference (TYPE)	STRING		Object URL	20110510
3	Importing	I_LOIO	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID		Logical Document in KPro	20110510

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	Unspecified Error Occurred	20110510
2	NOT_FOUND	☐	Object Not Found	20110510
3	PARAMETER_MISSING	☐	Parameter missing or is initial	20110510

Method PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_BIN_DATA	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Art der Datenübertragung: X-binäre Daten, ''- Textdaten	20030603
2	Exporting	E_IS_FOLDER	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X-Objekt ist Ordner, ''-sonst Datei	20030603
3	Exporting	E_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU		Sprache des PHIO	20031120
4	Exporting	E_LOIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		Logisches Dokument in KPro	20030603
5	Exporting	E_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		MIME-Typ	20030603
6	Exporting	E_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Datei-Name	20030603
7	Exporting	E_PHIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		Physisches Dokument in KPro	20030603
8	Exporting	E_PHIO_LAST_CHANGED	Call by reference	☐	Type reference (TYPE)	SMIMPHIO-CHNG_TIME		Änderungszeitpunkt (UTC) des PHIO	20031120
9	Exporting	E_SIZE	Call by reference	☐	Type reference (TYPE)	I		Dateigröße	20030603
10	Importing	I_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	'X'	X-Berechtigung prüfen, ''-keine Berechtigungsprüfung	20030603
11	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Objekt-URL	20030603

#	Exception	Resumable	Description	Created on
1	ERROR_OCCURED	☐	Unspezifischer Fehler aufgetreten	20030603
2	NOT_FOUND	☐	Objekt nicht gefunden	20030603
3	PARAMETER_MISSING	☐	Parameter fehlt oder ist initial	20030603
4	PERMISSION_FAILURE	☐	fehlende Berechtigung	20030603

Method PUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	'X'	X-Berechtigung prüfen, ''-keine Berechtigungsprüfung	20030513
2	Importing	I_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Objekt-Inhalt (wenn vorhanden->Inhalt überschreiben)	20030513
3	Importing	I_CORR_NUMBER	Call by reference	☑	Type reference (TYPE)	TRKORR		Auftrag/Aufgabe	20030513
4	Importing	I_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		Für neues Objekt: Objekt-Kurzbeschreibung	20030515
5	Importing	I_DEV_PACKAGE	Call by reference	☑	Type reference (TYPE)	DEVCLASS		Paket (initial->Dialog/Vaterpaket übernehmen)	20030513
6	Importing	I_GENFLAG	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE		20130207
7	Importing	I_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Sprache des MIME-Objektes	20030514
8	Importing	I_NEW_LOIO	Call by reference	☑	Type reference (TYPE)	SKWF_IO		Nur für Anlegen: eindeutige Objekt-Id, falls bekannt	20030909
9	Importing	I_SUPPRESS_DIALOGS	Call by reference	☑	Type reference (TYPE)	BOOLE_D		X-Keine Dialoge	20100312
10	Importing	I_SUPPRESS_PACKAGE_DIALOG	Call by reference	☐	Type reference (TYPE)	BOOLE_D	SPACE	Für neues Objekt: X-Paketabfrage unterdrücken	20030515
11	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Objekt-URL	20030513
12	Importing	I_VIRUS_PROFILE	Call by reference	☐	Type reference (TYPE)	VSCAN_PROFILE	C_VIRUS_PROFILE		20120419

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	Aktion wurde abgebrochen	20030513
2	DATA_INCONSISTENCY	☐	Interne Dateninkonsistenz	20030514
3	ERROR_OCCURED	☐	Unspezifischer Fehler aufgetreten	20030513
4	IS_FOLDER	☐	Gegebene ULR ist ein Ordner	20030910
5	NEW_LOIO_ALREADY_EXISTS	☐	Vorgegebene GUId für neues LOIO ist bereits vergeben	20030909
6	PARAMETER_MISSING	☐	Parameter fehlt oder ist initial	20030513
7	PERMISSION_FAILURE	☐	fehlende Berechtigung	20030513

History

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