SAP ABAP Interface IF_EDMS_COMMON_FILE (CDOCS: Shared Interface for All File Types)
Hierarchy
☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-DOC (Application Component) Engineering Documents
     ⤷ EDMS_DOCUMENT (Package) EDMS: Documents
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface composition (i COMPRISING i_ref)  IF_EDMS_MAIN_FILE EDMS: Main File 20020408
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_DPR_CFX_DOCUMENT Project Management Document Class 20050215
3 Interface implementation (CLASS c. INTERFACES i_ref)  CL_DPR_CFX_DOCUMENT_VERSION CDOCS: Main Files 20050223
4 Interface implementation (CLASS c. INTERFACES i_ref)  CL_EDMS_MAIN_FILE EDMS: Main Files 20020408
Properties
Interface IF_EDMS_COMMON_FILE  
Short Description CDOCS: Shared Interface for All File Types    
General Data
Package EDMS_DOCUMENT   EDMS: Documents 
Created 20020408   SAP 
Last changed 20141109    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Interface IF_EDMS_COMMON_FILE has no interface.
Friends
Interface IF_EDMS_COMMON_FILE has no friend.
Attributes
Interface IF_EDMS_COMMON_FILE has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 CANCEL_CHECKOUT Instance method Public Method Cancel Check Out 20020410
2 CHECKIN_FILE Instance method Public Method Check In File (Frontend or Backend) 20020408
3 CHECKIN_TABLE Instance method Public Method Check In Internal Table 20020408
4 CHECKIN_XSTRING Instance method Public Method Check In Xstring 20020408
5 CHECKOUT_FILE Instance method Public Method Check Out File (Frontend or Backend) 20020408
6 CHECKOUT_TABLE Instance method Public Method Check Out into Internal Table 20020408
7 CHECKOUT_XSTRING Instance method Public Method Check Out in Xstring 20020408
8 DELETE Instance method Public Method Delete 20020408
9 FREE Instance method Public Method Free allocated Resources 20130719
10 GET_BASENAME Instance method Public Method Component Name (Without Path and Extension) 20020408
11 GET_CHANGED_AT Instance method Public Method Created On 20020408
12 GET_CHANGED_BY Instance method Public Method Changed By 20020408
13 GET_CHECKEDOUT_PROPERTIES Instance method Public Method Read Checkout Data 20020410
14 GET_CREATED_AT Instance method Public Method Created On 20020408
15 GET_CREATED_BY Instance method Public Method Created By 20020408
16 GET_DESCRIPTION Instance method Public Method Read Description 20020414
17 GET_EXTENSION Instance method Public Method File Extension 20020408
18 GET_FILE Instance method Public Method File Name Without Path 20020408
19 GET_FILENAME Instance method Public Method Determine File Name 20020408
20 GET_FILESIZE Instance method Public Method Determine File Size 20020408
21 GET_ID Instance method Public Method File ID 20020408
22 GET_MIMETYPE Instance method Public Method Read MIME Type 20020408
23 GET_PATHNAME Instance method Public Method Path Name (Without File) 20020408
24 GET_READ_URL Instance method Public Method URL To Be Read 20020408
25 GET_STORAGE_CATEGORY Instance method Public Method Determine Storage Category 20020408
26 GET_WRITE_URL Instance method Public Method URL To Be Written 20020408
27 HAS_CONTENT Instance method Public Method Does PHIO Have Content? 20020408
28 INITIALIZE Instance method Public Method Read from DB or Create New Instance 20020408
29 IS_CHECKED_OUT Instance method Public Method File Checked Out? 20020410
30 IS_LOCKED Instance method Public Method Is PHIO Locked/Checked Out? 20020408
31 IS_PERSISTENT Instance method Public Method Is PHIO Persistent 20020408
32 IS_UNPROTECTED Instance method Public Method Is PHIO Unprotected 20020408
33 RELOCATE_CONTENT Instance method Public Method Transfer Document to Another Category 20020410
34 REMOVE_LOCK Instance method Public Method Remove Lock 20020408
35 SAVE Instance method Public Method Save 20020408
36 SAVE_AS_URL Instance method Public Method Save File Without Content 20020409
37 SET_CHECKEDOUT Instance method Public Method Mark File as Checked Out 20020410
38 SET_DESCRIPTION Instance method Public Method Set Description 20020414
39 SET_FILENAME Instance method Public Method Set File Name 20020408
40 SET_FTP_DESTINATION Instance method Public Method Define FTP Destination 20020408
41 SET_HTTP_DESTINATION Instance method Public Method Define HTTP Destination 20020408
42 SET_LOCK Instance method Public Method Set Lock 20020408
43 SET_MIMETYPE Instance method Public Method Set MIME Type 20020408
44 SET_STORAGE_CATEGORY Instance method Public Method Set Storage Category 20020408
Events
# Event Type Visibility Description Created on
1 CHANGED Instance Event
(0) 		Public
(2) 		File Changed 20070419
2 CREATED Instance Event
(0) 		Public
(2) 		File Created Again 20070419
3 DELETED Instance Event
(0) 		Public
(2) 		File Deleted 20070419
4 MOVED Instance Event
(0) 		Public
(2) 		File Moved 20070419
Types
Interface IF_EDMS_COMMON_FILE has no local type.
Method Signatures

Method CANCEL_CHECKOUT Signature

Method CANCEL_CHECKOUT on Interface IF_EDMS_COMMON_FILE has no parameter.
Method CANCEL_CHECKOUT on Interface IF_EDMS_COMMON_FILE has no exception.

Method CHECKIN_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_IS_NEW_VERSION Call by reference Type reference (TYPE) ABAP_BOOL Ist neue Version 20020430
2 Exporting E_NEW_ID Call by reference Type reference (TYPE) SDOK_PHID Physisches Dokument 20020430
3 Importing I_FILENAME Call by reference Type reference (TYPE) EDMS_URL SAP ArchiveLink: Datenelement für absolute URI 20020408
4 Importing I_MIMETYPE Call by reference Type reference (TYPE) W3CONTTYPE HTML-Content-Type 20020408
5 Importing I_NEW_VERSION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Neue Version erstellen 20020408

Method CHECKIN_FILE on Interface IF_EDMS_COMMON_FILE has no exception.

Method CHECKIN_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_IS_NEW_VERSION Call by reference Type reference (TYPE) ABAP_BOOL Ist neue Version 20020430
2 Exporting E_NEW_ID Call by reference Type reference (TYPE) SDOK_PHID Physisches Dokument 20020430
3 Importing IT_CONTENT Call by reference Type reference (TYPE) SDOKCNTBINS SDOK: Tabelle von Binärdokumentinhalten für den Web-Server 20020408
4 Importing I_FILENAME Call by reference Type reference (TYPE) EDMS_URL Dateiname 20020408
5 Importing I_FILESIZE Call by reference Type reference (TYPE) I Dateigröße 20020408
6 Importing I_MIMETYPE Call by reference Type reference (TYPE) W3CONTTYPE HTML-Content-Type 20020408
7 Importing I_NEW_VERSION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Neue Version anlegen 20020408

Method CHECKIN_TABLE on Interface IF_EDMS_COMMON_FILE has no exception.

Method CHECKIN_XSTRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_IS_NEW_VERSION Call by reference Type reference (TYPE) ABAP_BOOL Ist neue Version 20020430
2 Exporting E_NEW_ID Call by reference Type reference (TYPE) SDOK_PHID Physisches Dokument 20020430
3 Importing I_CONTENT Call by reference Type reference (TYPE) XSTRING Content 20020408
4 Importing I_FILENAME Call by reference Type reference (TYPE) EDMS_URL SAP ArchiveLink: Datenelement für absolute URI 20020408
5 Importing I_FILESIZE Call by reference Type reference (TYPE) I 20020408
6 Importing I_MIMETYPE Call by reference Type reference (TYPE) W3CONTTYPE HTML-Content-Type 20020408
7 Importing I_NEW_VERSION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Neue Version erstellen 20020408

Method CHECKIN_XSTRING on Interface IF_EDMS_COMMON_FILE has no exception.

Method CHECKOUT_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_FILENAME Call by reference Type reference (TYPE) EDMS_URL SAP ArchiveLink: Datenelement für absolute URI 20020408

Method CHECKOUT_FILE on Interface IF_EDMS_COMMON_FILE has no exception.

Method CHECKOUT_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_CONTENT Value transfer Type reference (TYPE) SDOKCNTBINS SDOK: Tabelle von Binärdokumentinhalten für den Web-Server 20020408

Method CHECKOUT_TABLE on Interface IF_EDMS_COMMON_FILE has no exception.

Method CHECKOUT_XSTRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_CONTENT Value transfer Type reference (TYPE) XSTRING Content 20020408

Method CHECKOUT_XSTRING on Interface IF_EDMS_COMMON_FILE has no exception.

Method DELETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DELETE_DEPENDENCE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20020408

Method DELETE on Interface IF_EDMS_COMMON_FILE has no exception.

Method FREE Signature

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

Method GET_BASENAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_BASENAME Value transfer Type reference (TYPE) EDMS_URL SAP ArchiveLink: Datenelement für absolute URI 20020408

Method GET_BASENAME on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_CHANGED_AT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_CHANGED_AT Value transfer Type reference (TYPE) TZNTSTMPS Geändert am 20020408

Method GET_CHANGED_AT on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_CHANGED_BY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_CHANGED_BY Value transfer Type reference (TYPE) SY-UNAME Geändert von 20020408

Method GET_CHANGED_BY on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_CHECKEDOUT_PROPERTIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_DIRECTORY Call by reference Type reference (TYPE) EDMS_DIRECTORY EDMS: Verzeichnis 20020410
2 Exporting E_FILENAME Call by reference Type reference (TYPE) EDMS_FILENAME EDMS: Dateiname 20020410
3 Exporting E_HOSTNAME Call by reference Type reference (TYPE) EDMS_HOSTNAME EDMS: Hostname 20020410
4 Exporting E_USERNAME Call by reference Type reference (TYPE) UNAME Benutzername 20020410

Method GET_CHECKEDOUT_PROPERTIES on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_CREATED_AT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_CREATED_AT Value transfer Type reference (TYPE) TZNTSTMPS Erstellt am 20020408

Method GET_CREATED_AT on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_CREATED_BY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_CREATED_BY Value transfer Type reference (TYPE) SY-UNAME Erstellt von 20020408

Method GET_CREATED_BY on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_DESCRIPTION Value transfer Type reference (TYPE) EDMS_FILE_DESCRIPTION EDMS: Dateibezeichnung 20020414

Method GET_DESCRIPTION on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_EXTENSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_EXTENSION Value transfer Type reference (TYPE) W3FILEEXT Filenamenserweiterung 20020408

Method GET_EXTENSION on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_FILE Value transfer Type reference (TYPE) EDMS_URL SAP ArchiveLink: Datenelement für absolute URI 20020408

Method GET_FILE on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_FILENAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_FILENAME Value transfer Type reference (TYPE) EDMS_URL Dateiname 20020408

Method GET_FILENAME on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_FILESIZE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_FILESIZE Value transfer Type reference (TYPE) I Dateigröße 20020408

Method GET_FILESIZE on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_ID Value transfer Type reference (TYPE) EDMS_FILE_ID Physisches Dokument 20020408

Method GET_ID on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_MIMETYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_MIMETYPE Value transfer Type reference (TYPE) W3CONTTYPE HTML-Content-Type 20020408

Method GET_MIMETYPE on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_PATHNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_PATHNAME Value transfer Type reference (TYPE) EDMS_URL SAP ArchiveLink: Datenelement für absolute URI 20020408

Method GET_PATHNAME on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_READ_URL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_URL Value transfer Type reference (TYPE) SAEURI URL zum lesen 20020408

Method GET_READ_URL on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_STORAGE_CATEGORY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_STORAGE_CATEGORY Value transfer Type reference (TYPE) SDOK_STCAT Kategorie für physische Dokumente 20020408

Method GET_STORAGE_CATEGORY on Interface IF_EDMS_COMMON_FILE has no exception.

Method GET_WRITE_URL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_URL Value transfer Type reference (TYPE) SAEURI SAP ArchiveLink: Datenelement für absolute URI 20020408

Method GET_WRITE_URL on Interface IF_EDMS_COMMON_FILE has no exception.

Method HAS_CONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_HAS_CONTENT Value transfer Type reference (TYPE) ABAP_BOOL 20020408

Method HAS_CONTENT on Interface IF_EDMS_COMMON_FILE has no exception.

Method INITIALIZE Signature

Method INITIALIZE on Interface IF_EDMS_COMMON_FILE has no parameter.
Method INITIALIZE on Interface IF_EDMS_COMMON_FILE has no exception.

Method IS_CHECKED_OUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_CHECKEDOUT_BY Call by reference Type reference (TYPE) UNAME Benutzername 20020410
2 Exporting E_IS_CHECKED_OUT Call by reference Type reference (TYPE) ABAP_BOOL 20020410

Method IS_CHECKED_OUT on Interface IF_EDMS_COMMON_FILE has no exception.

Method IS_LOCKED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_IS_LOCKED Call by reference Type reference (TYPE) ABAP_BOOL 20020408
2 Exporting E_LOCKED_BY Call by reference Type reference (TYPE) SY-UNAME R/3-System, Anmeldename des Benutzers 20020408

Method IS_LOCKED on Interface IF_EDMS_COMMON_FILE has no exception.

Method IS_PERSISTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_PERSISTENT Value transfer Type reference (TYPE) ABAP_BOOL 20020408

Method IS_PERSISTENT on Interface IF_EDMS_COMMON_FILE has no exception.

Method IS_UNPROTECTED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_IS_UNPROTECTED Value transfer Type reference (TYPE) ABAP_BOOL Unprotected 20020408

Method IS_UNPROTECTED on Interface IF_EDMS_COMMON_FILE has no exception.

Method RELOCATE_CONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_STORAGE_CATEGORY Call by reference Type reference (TYPE) SDOK_STCAT Kategorie für physische Dokumente 20020410

Method RELOCATE_CONTENT on Interface IF_EDMS_COMMON_FILE has no exception.

Method REMOVE_LOCK Signature

Method REMOVE_LOCK on Interface IF_EDMS_COMMON_FILE has no parameter.
Method REMOVE_LOCK on Interface IF_EDMS_COMMON_FILE has no exception.

Method SAVE Signature

Method SAVE on Interface IF_EDMS_COMMON_FILE has no parameter.
Method SAVE on Interface IF_EDMS_COMMON_FILE has no exception.

Method SAVE_AS_URL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_FILENAME Call by reference Type reference (TYPE) SAEURI SAP ArchiveLink: Datenelement für absolute URI 20020409
2 Importing I_FILESIZE Call by reference Type reference (TYPE) I Dateigröße 20020409
3 Importing I_MIMETYPE Call by reference Type reference (TYPE) W3CONTTYPE HTML-Content-Type 20020409
4 Importing I_NEW_VERSION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Neue Version 20020419

Method SAVE_AS_URL on Interface IF_EDMS_COMMON_FILE has no exception.

Method SET_CHECKEDOUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_FILENAME Call by reference Type reference (TYPE) EDMS_URL SAP ArchiveLink: Datenelement für absolute URI 20020410
2 Importing I_HOSTNAME Call by reference Type reference (TYPE) EDMS_HOSTNAME EDMS: Hostname 20020410
3 Importing I_USER Call by reference Type reference (TYPE) UNAME SY-UNAME Benutzername 20020410

Method SET_CHECKEDOUT on Interface IF_EDMS_COMMON_FILE has no exception.

Method SET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DESCRIPTION Value transfer Type reference (TYPE) EDMS_FILE_DESCRIPTION EDMS: Dateibezeichnung 20020414

Method SET_DESCRIPTION on Interface IF_EDMS_COMMON_FILE has no exception.

Method SET_FILENAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_FILENAME Call by reference Type reference (TYPE) EDMS_URL SAP ArchiveLink: Datenelement für absolute URI 20020408

Method SET_FILENAME on Interface IF_EDMS_COMMON_FILE has no exception.

Method SET_FTP_DESTINATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DESTINATION Call by reference Type reference (TYPE) RFCDEST logische Destination (Wird bei Funktionsaufruf angegeben) 20020408

Method SET_FTP_DESTINATION on Interface IF_EDMS_COMMON_FILE has no exception.

Method SET_HTTP_DESTINATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DESTINATION Call by reference Type reference (TYPE) RFCDEST logische Destination (Wird bei Funktionsaufruf angegeben) 20020408

Method SET_HTTP_DESTINATION on Interface IF_EDMS_COMMON_FILE has no exception.

Method SET_LOCK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_USER Call by reference Type reference (TYPE) UNAME SY-UNAME Benutzername 20020408

Method SET_LOCK on Interface IF_EDMS_COMMON_FILE has no exception.

Method SET_MIMETYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_MIMETYPE Call by reference Type reference (TYPE) W3CONTTYPE HTML-Content-Type 20020408

Method SET_MIMETYPE on Interface IF_EDMS_COMMON_FILE has no exception.

Method SET_STORAGE_CATEGORY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_STORAGE_CATEGORY Call by reference Type reference (TYPE) SDOK_STCAT Kategorie für physische Dokumente 20020408

Method SET_STORAGE_CATEGORY on Interface IF_EDMS_COMMON_FILE has no exception.
Event Signatures

Event CHANGED Signature
Event CHANGED on Interface IF_EDMS_COMMON_FILE has no parameter.
Event CREATED Signature
Event CREATED on Interface IF_EDMS_COMMON_FILE has no parameter.
Event DELETED Signature
Event DELETED on Interface IF_EDMS_COMMON_FILE has no parameter.
Event MOVED Signature
Event MOVED on Interface IF_EDMS_COMMON_FILE has no parameter.
History
Last changed by/on SAP  20141109 
SAP Release Created in 200