SAP ABAP Class CL_MIME_REPOSITORY_API (API for MIME Repository)
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 - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_MR_API | API for MIME Repository - Basic Functions | 20030430 |
Properties
| Class | CL_MIME_REPOSITORY_API | |
| Short Description | API for MIME Repository | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SMIM_API | MIME Repository - API |
| Created | 20030430 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 3 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 4 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 5 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_MR_API | API for MIME Repository - Basic Functions | 20030430 |
Friends
Class CL_MIME_REPOSITORY_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Type reference (TYPE) | SDOK_DESCR | Valid Prefix for API | 20030911 | |||
| 2 | Constant | Private | Type reference (TYPE) | SDOK_DESCR | '/SAP/BC/BSP/' | Prefix for BSP Applications | 20030911 | ||
| 3 | Constant | Private | Type reference (TYPE) | CHAR20 | 'APPL_FOLDER' | Application Folder | 20031015 | ||
| 4 | Constant | Private | Type reference (TYPE) | CHAR20 | 'NSP_FOLDER' | Application Folder | 20031015 | ||
| 5 | Constant | Private | Type reference (TYPE) | CHAR20 | 'PMODEL' | Programming Model | 20031015 | ||
| 6 | Constant | Private | Type reference (TYPE) | CHAR20 | 'PUBLIC' | Public Folder | 20031015 | ||
| 7 | Constant | Private | Type reference (TYPE) | CHAR20 | 'ROOT' | Root Folder | 20031015 | ||
| 8 | Constant | Private | Type reference (TYPE) | CHAR20 | 'SUBFOLDER' | Subfolder | 20031015 | ||
| 9 | Constant | Private | Type reference (TYPE) | CHAR20 | 'SW_COMPONENT' | Software Component | 20031015 | ||
| 10 | Instance attribute | Private | Type reference (TYPE) | TRKORR | Default Request/Task for API | 20030513 | |||
| 11 | Instance attribute | Private | Type reference (TYPE) | DEVCLASS | Default Package for API | 20030513 | |||
| 12 | Static Attribute | Private | Type reference (TYPE) | BOOLE_D | 'X' | Enhanced MR Version Active | 20030915 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Returns Folder Role | 20031015 | |
| 2 | Instance method | Public | Method | Create Folder in MIME Repository | 20030522 | |
| 3 | Instance method | Private | Method | Supply Contents of a MIME Object | 20110510 | |
| 4 | Instance method | Public | Method | 20030928 | ||
| 5 | Instance method | Private | Method | Returns first matching PHIO from list of PHIOs | 20090318 | |
| 6 | Instance method | Private | Method | Returns a PHIO matching an LOIO | 20090318 | |
| 7 | Static method | Public | Method | Return Valid URL | 20030918 | |
| 8 | Instance method | Private | Method | Add New Folder Role | 20040126 | |
| 9 | Static method | Private | Method | Invalidates Objects in HTTP Server Cache (ICM) | 20030527 | |
| 10 | Static method | Public | Method | Select MIME Root | 20041129 |
Events
Class CL_MIME_REPOSITORY_API has no event.
Types
Class CL_MIME_REPOSITORY_API has no local type.
Method Signatures
Method CHECK_FOLDER_ROLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_FOLDER_ROLE | Call by reference | Type reference (TYPE) | CHAR20 | Ordner-Rolle | 20031015 | |||
| 2 | I_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Objekt-URL | 20031015 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Parameter fehlt oder ist initial | 20031015 |
Method CREATE_ROOT_FOLDER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_FOLDER_IO | Call by reference | Type reference (TYPE) | SKWF_IO | Ordner-IO | 20030522 | |||
| 2 | I_CHECK_AUTHORITY | Call by reference | Type reference (TYPE) | BOOLE_D | 'X' | X-Berechtigung prüfen, ''-keine Berechtigungsprüfung | 20030522 | ||
| 3 | I_CORR_NUMBER | Call by reference | Type reference (TYPE) | TRKORR | Auftrag/Aufgabe | 20030522 | |||
| 4 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | CSEQUENCE | Kurzbeschreibung | 20030522 | |||
| 5 | I_DEV_PACKAGE | Call by reference | Type reference (TYPE) | DEVCLASS | Paket (initial->Dialog/Vaterpaket) | 20030522 | |||
| 6 | I_FOLDER_ROLE | Value transfer | Type reference (TYPE) | MR_FROLE | 'CUSTOMER' | Ordnerrolle, falls bekannt | 20040126 | ||
| 7 | I_GENFLAG | Call by reference | Type reference (TYPE) | BOOLE_D | 20130207 | ||||
| 8 | I_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | SY-LANGU | Originalsprache | 20030522 | ||
| 9 | I_NEW_FOLDER_ROLE_DESCRIPTION | Call by reference | Type reference (TYPE) | DDTEXT | SPACE | Kurztext für neue Ordnerrolle | 20040126 | ||
| 10 | I_ROOT_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Root-Name | 20030522 | |||
| 11 | I_SUPPRESS_DIALOGS | Call by reference | Type reference (TYPE) | BOOLE_D | X-Unterdrücken von Dialogen | 20100312 | |||
| 12 | I_SUPPRESS_PACKAGE_DIALOG | Call by reference | Type reference (TYPE) | BOOLE_D | SPACE | X-Paketabfrage unterdrücken | 20030522 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Aktion wurde abgebrochen | 20030522 | ||
| 2 | Unspezifischer Fehler aufgetreten | 20030522 | ||
| 3 | Ordner existiert bereits | 20030522 | ||
| 4 | Parameter fehlt oder ist initial | 20030522 | ||
| 5 | fehlende Berechtigung | 20030522 |
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | Object Language | 20110510 | |||
| 2 | E_CONTENT | Call by reference | Type reference (TYPE) | XSTRING | Object Contents | 20110510 | |||
| 3 | E_CONTENT_LAST_CHANGED | Call by reference | Type reference (TYPE) | SMIMPHIO-CHNG_TIME | Change Time (UTC) of Content | 20110510 | |||
| 4 | E_IS_FOLDER | Call by reference | Type reference (TYPE) | BOOLE_D | X - Object is folder, '' - Otherwise file | 20110510 | |||
| 5 | E_LOIO | Call by reference | Type reference (TYPE) | SKWF_IO | Technical Object Key Incl. MIME-GUID | 20110510 | |||
| 6 | E_MIME_TYPE | Call by reference | Type reference (TYPE) | CSEQUENCE | MIME Type | 20110510 | |||
| 7 | I_CHECK_AUTHORITY | Call by reference | Type reference (TYPE) | BOOLE_D | 'X' | X Check Authorization, '' No Authorization Check | 20110510 | ||
| 8 | I_LOIO | Call by reference | Type reference (TYPE) | SKWF_IO | KW Framework: Object Key | 20110510 | |||
| 9 | I_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Object URL | 20110510 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Unspecified Error Occurred | 20110510 | ||
| 2 | Object Not Found | 20110510 | ||
| 3 | Parameter missing or is initial | 20110510 | ||
| 4 | Missing Authorization | 20110510 |
Method GET_API Signature
Method GET_API on class CL_MIME_REPOSITORY_API has no parameter.
Method GET_API on class CL_MIME_REPOSITORY_API has no exception.
Method GET_NEWEST_PHIO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CH_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | Sprachenschlüssel der aktuellen Textumgebung | 20090318 | |||
| 2 | EX_LAST_CHANGED | Call by reference | Type reference (TYPE) | SMIMPHIO-CHNG_TIME | Änderungszeitpunkt (UTC) | 20090318 | |||
| 3 | EX_PHIO | Call by reference | Type reference (TYPE) | SKWF_IO | KW Framework: Objektschlüssel | 20090318 | |||
| 4 | IM_ALL_PROPERTIES | Call by reference | Type reference (TYPE) | SDOKPROPTLS | Liste von Attributausprägungen von Objekten | 20090318 | |||
| 5 | IM_CHANGE_DATES | Call by reference | Type reference (TYPE) | SDOKPROPTLS | Sortierte Liste von Änderungsangaben | 20090318 |
Method GET_NEWEST_PHIO on class CL_MIME_REPOSITORY_API has no exception.
Method GET_PHIO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CH_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | Sprachenschlüssel der aktuellen Textumgebung | 20090318 | |||
| 2 | EX_LAST_CHANGED | Call by reference | Type reference (TYPE) | SMIMPHIO-CHNG_TIME | Änderungszeitpunkt (UTC) | 20090318 | |||
| 3 | EX_PHIO | Call by reference | Type reference (TYPE) | SKWF_IO | KW Framework: Objektschlüssel | 20090318 | |||
| 4 | IM_LOIO | Call by reference | Type reference (TYPE) | SKWF_IO | KW Framework: Objektschlüssel | 20090318 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090318 |
Method GET_VALID_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Objekt-URL | 20030918 | |||
| 2 | I_API_PREFIX | Call by reference | Type reference (TYPE) | SDOK_DESCR | SPACE | Gültiger Präfix für API | 20030918 |
Method GET_VALID_URL on class CL_MIME_REPOSITORY_API has no exception.
Method INSERT_FOLDER_ROLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_FOLDER_ROLE | Call by reference | Type reference (TYPE) | MR_FROLE | Neue Ordnerrolle | 20040126 | |||
| 2 | I_FOLDER_ROLE_DESCRIPTION | Call by reference | Type reference (TYPE) | DDTEXT | SPACE | Kurztext für neue Ordnerrolle | 20040126 | ||
| 3 | I_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | SY-LANGU | Originalsprache | 20040126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Parameter ist initial | 20040126 | ||
| 2 | Ordnerrolle existiert bereits | 20040126 |
Method INVALIDATE_ICM_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_CHANGED_IOS | Call by reference | Type reference (TYPE) | SKWF_IOS | Geänderte Objekte | 20030527 | |||
| 2 | I_GET_ALL_PHIOS | Call by reference | Type reference (TYPE) | BOOLE_D | '' | X-PHIOs bestimmen und mit invalidieren | 20030528 | ||
| 3 | I_INVALIDATE_CHILDREN | Call by reference | Type reference (TYPE) | BOOLE_D | '' | Für Ordner: X-Subobjekte bestimmen und mit invalidieren | 20030527 |
Method INVALIDATE_ICM_CACHE on class CL_MIME_REPOSITORY_API has no exception.
Method SELECT_MIME_ROOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_ROOT_WA | Call by reference | Type reference (TYPE) | SKWF_ROOT | SWFK_ROOT-WA | 20041129 | |||
| 2 | I_ROOT_GUID | Call by reference | Type reference (TYPE) | SDOK_DOCID | MIME-Root-Id | 20041129 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Root-Eintrag wurde nicht gefunden | 20041129 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 640 |