SAP ABAP Interface IF_CFX_DOCUMENT (Common Interface for All Documents)
Hierarchy
☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_FOLDERS (Package) Collaboration Folders: Folder and Documents
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface composition (i COMPRISING i_ref)  IF_CFX_VERSIONING Common Interface for All Versional Documents 20011030
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CFX_COMMON_DOCUMENT General Document Class 20041108
3 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CFX_DATA_SHEET Specification Data Sheet 20001206
4 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CFX_DISCUSSION XML-Based Discussion/Chat 20001108
5 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CFX_GENERIC_OBJECT Folder Object Generic Object in cFolders 20030121
6 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CFX_HYPERLINK XML-Based Hyperlink 20001127
7 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CFX_MATERIAL Material in cFolders 20020222
8 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CFX_STRUCTURE BOM Header 20020225
9 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CFX_TEXT XML-Based Continuous Text 20001205
Properties
Interface IF_CFX_DOCUMENT  
Short Description Common Interface for All Documents    
General Data
Package CFX_FOLDERS   Collaboration Folders: Folder and Documents 
Created 20001107   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)
2 CFXF1 Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_ACO_COMMON Common Interface for Authorization Check 20020423
2 IF_CFX_ALIAS Alias Names for Objects 20010613
3 IF_CFX_COMMON Common Interface for All Objects 20010808
4 IF_CFX_DOCUMENT_HELP Help Interface for IF_CFX_DOCUMENT 20090617
5 IF_CFX_GO_DATA_PARENT Object Interface for Object with Generic Data 20030130
6 IF_CFX_ITERATOR_ELEMENT Common Interface for All Objects That Can Be Iterated 20001108
Friends
Interface IF_CFX_DOCUMENT has no friend.
Attributes
Interface IF_CFX_DOCUMENT has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_LINK_ALLOWED Instance method Public Method Can Both Documents Belong to the Same BOM? 20020424
2 COPY Instance method Public Method Generate Copy 20001107
3 DELETE Instance method Public Method Delete 20001107
4 DELETE_WITHOUT_CHECK Instance method Public Method Delete Without Check 20020723
5 FREEZE Instance method Public Method Freezing of Document 20001107
6 GET_AUTHORITY Instance method Public Method Return Authority Object 20001218
7 GET_COPIES Instance method Public Method Return Copied Document 20001205
8 GET_COPY_SOURCE Instance method Public Method Return Copy Source 20001205
9 GET_DESCRIPTION Instance method Public Method Description 20001109
10 GET_ID Instance method Public Method Return the 32-Digit GUID to SKWF_10 20001117
11 GET_LOCK_USER Instance method Public Method Determines the Locking User or Initial for No Lock 20001127
12 GET_NAME Instance method Public Method Names 20001109
13 GET_PARENT_FOLDER Instance method Public Method Superordinate Folder 20001109
14 GET_PROPERTIES Instance method Public Method Delivers Characteristics for Document 20010907
15 GET_URL Instance method Public Method URL of Document 20001107
16 IS_FROZEN Instance method Public Method Determines If Document is Frozen 20001218
17 IS_MASTER Instance method Public Method Reads Master Flag from Properties 20020325
18 IS_NOT_PERSISTENT Instance method Public Method Is Document Persistent (in SKWF)? 20020419
19 LOCK Instance method Public Method Locking of Document 20001107
20 MOVE Instance method Public Method Drag Document to a New Target Foldder 20001107
21 SAVE Instance method Public Method Save Non-Persistent Object 20020419
22 SET_DESCRIPTION Instance method Public Method Change Description 20001107
23 SET_MASTER Instance method Public Method Sets Master Flag in Properties 20020325
24 SET_NAME Instance method Public Method Change name 20001107
25 UNLOCK Instance method Public Method Unlocking of Document 20001107
Events
# Event Type Visibility Description Created on
1 BEFORE_COPY Instance Event
(0) 		Public
(2) 		20060804
2 COPIED Instance Event
(0) 		Public
(2) 		20010608
3 DELETED Instance Event
(0) 		Public
(2) 		A Document Was Deleted 20010719
Types
Interface IF_CFX_DOCUMENT has no local type.
Method Signatures

Method CHECK_LINK_ALLOWED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_COMMON Call by reference Object reference (TYPE REF TO) IF_CFX_COMMON Gemeinsame Schnittstelle aller Dokumente 20031205
2 Importing I_ALLOW_STANDARD_PARTS Call by reference Type reference (TYPE) CFX_BOOLEAN Darf ip_document in Collaboration für Standard Teile sein ? 20031010

Method CHECK_LINK_ALLOWED on Interface IF_CFX_DOCUMENT has no exception.

Method COPY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CLEANUP_DIRECTLY Call by reference Type reference (TYPE) CFX_BOOLEAN ABAP_FALSE Sollen cleanup Methoden aufgerufen werden? 20020508
2 Importing I_DESTINATION_FOLDER Call by reference Object reference (TYPE REF TO) CL_CFX_COMMON_FOLDER Mappe für Collaboration Folders 20001114
3 Importing I_NAME Call by reference Type reference (TYPE) STRING 20001114
4 Importing I_RAISE_EVENT Call by reference Type reference (TYPE) CFX_BOOLEAN ABAP_TRUE Boolscher Typ 20010712
5 Returning RP_DOCUMENT_COPY Value transfer Object reference (TYPE REF TO) IF_CFX_DOCUMENT Referenz auf kopiertes Objekt 20001205

Method COPY on Interface IF_CFX_DOCUMENT has no exception.

Method DELETE Signature

Method DELETE on Interface IF_CFX_DOCUMENT has no parameter.
Method DELETE on Interface IF_CFX_DOCUMENT has no exception.

Method DELETE_WITHOUT_CHECK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CHECK_SKWF_ERROR Call by reference Type reference (TYPE) CFX_BOOLEAN ABAP_TRUE Boolscher Typ 20020723

Method DELETE_WITHOUT_CHECK on Interface IF_CFX_DOCUMENT has no exception.

Method FREEZE Signature

Method FREEZE on Interface IF_CFX_DOCUMENT has no parameter.
Method FREEZE on Interface IF_CFX_DOCUMENT has no exception.

Method GET_AUTHORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_AUTHORITY Value transfer Object reference (TYPE REF TO) CL_CFX_AUTHORITY Collaboration: Authority 20001218

Method GET_AUTHORITY on Interface IF_CFX_DOCUMENT has no exception.

Method GET_COPIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_COPY_DESTINATION Value transfer Type reference (TYPE) CFX_TT_IF_CFX_DOCUMENT Tabelle mit Einträgen des Typs IF_CFX_DOCUMENT 20001206

Method GET_COPIES on Interface IF_CFX_DOCUMENT has no exception.

Method GET_COPY_SOURCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_COPY_SOURCE Value transfer Object reference (TYPE REF TO) IF_CFX_DOCUMENT Gemeinsame Schnittstelle aller Dokumente 20001205

Method GET_COPY_SOURCE on Interface IF_CFX_DOCUMENT 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) STRING Beschreibung eines Dokuments 20001109

Method GET_DESCRIPTION on Interface IF_CFX_DOCUMENT has no exception.

Method GET_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_GUID Value transfer Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20001117

Method GET_ID on Interface IF_CFX_DOCUMENT has no exception.

Method GET_LOCK_USER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_LOCK_USER Value transfer Type reference (TYPE) CFX_USERID Sperrender User oder initial 20001127

Method GET_LOCK_USER on Interface IF_CFX_DOCUMENT has no exception.

Method GET_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_NAME Value transfer Type reference (TYPE) CFX_DOCUMENT_NAME Name eine Dokuments 20001109

Method GET_NAME on Interface IF_CFX_DOCUMENT has no exception.

Method GET_PARENT_FOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_PARENT_FOLDER Value transfer Object reference (TYPE REF TO) CL_CFX_COMMON_FOLDER Mappe für Collaboration Folders 20001128

Method GET_PARENT_FOLDER on Interface IF_CFX_DOCUMENT has no exception.

Method GET_PROPERTIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_CHANGED_BY Call by reference Type reference (TYPE) SYUNAME Anmeldename des Benutzers 20010907
2 Exporting E_CHANGED_BY_FULLNAME Call by reference Type reference (TYPE) STRING 20010907
3 Exporting E_CHANGED_ON_LOCAL_STR Call by reference Type reference (TYPE) STRING 20010907
4 Exporting E_CHANGED_ON_UTC Call by reference Type reference (TYPE) TZNTSTMPS UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) 20010907
5 Exporting E_CREATED_BY Call by reference Type reference (TYPE) SYUNAME Anmeldename des Benutzers 20010907
6 Exporting E_CREATED_BY_FULLNAME Call by reference Type reference (TYPE) STRING 20010907
7 Exporting E_CREATED_ON_LOCAL_STR Call by reference Type reference (TYPE) STRING 20010907
8 Exporting E_CREATED_ON_UTC Call by reference Type reference (TYPE) TZNTSTMPS UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) 20010907

Method GET_PROPERTIES on Interface IF_CFX_DOCUMENT has no exception.

Method GET_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) STRING globale URL des Dokuments 20001127

Method GET_URL on Interface IF_CFX_DOCUMENT has no exception.

Method IS_FROZEN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_IS_FROZEN Value transfer Type reference (TYPE) CFX_BOOLEAN Boolscher Typ 20001218

Method IS_FROZEN on Interface IF_CFX_DOCUMENT has no exception.

Method IS_MASTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_MASTER Value transfer Type reference (TYPE) CFX_BOOLEAN Boolscher Typ 20020325

Method IS_MASTER on Interface IF_CFX_DOCUMENT has no exception.

Method IS_NOT_PERSISTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_IS_NOT_PERSISTENT Value transfer Type reference (TYPE) CFX_BOOLEAN Boolscher Typ 20020419

Method IS_NOT_PERSISTENT on Interface IF_CFX_DOCUMENT has no exception.

Method LOCK Signature

Method LOCK on Interface IF_CFX_DOCUMENT has no parameter.
Method LOCK on Interface IF_CFX_DOCUMENT has no exception.

Method MOVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DESTINATION_FOLDER Call by reference Object reference (TYPE REF TO) CL_CFX_COMMON_FOLDER Mappe für Collaboration Folders 20001114

Method MOVE on Interface IF_CFX_DOCUMENT has no exception.

Method SAVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_NEW_ID Value transfer Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20020419

Method SAVE on Interface IF_CFX_DOCUMENT 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 Call by reference Type reference (TYPE) STRING Beschreibung eines Dokuments 20001109

Method SET_DESCRIPTION on Interface IF_CFX_DOCUMENT has no exception.

Method SET_MASTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_MASTER Call by reference Type reference (TYPE) CFX_BOOLEAN KW Framework: Objektschlüssel 20020325

Method SET_MASTER on Interface IF_CFX_DOCUMENT has no exception.

Method SET_NAME 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) CFX_DOCUMENT_NAME Name eine Dokuments 20001109

Method SET_NAME on Interface IF_CFX_DOCUMENT has no exception.

Method UNLOCK Signature

Method UNLOCK on Interface IF_CFX_DOCUMENT has no parameter.
Method UNLOCK on Interface IF_CFX_DOCUMENT has no exception.
Event Signatures

Event BEFORE_COPY Signature
Event BEFORE_COPY on Interface IF_CFX_DOCUMENT has no parameter.
Event COPIED Signature
Event COPIED on Interface IF_CFX_DOCUMENT has no parameter.
Event DELETED Signature
Event DELETED on Interface IF_CFX_DOCUMENT has no parameter.
History
Last changed by/on SAP  20141109 
SAP Release Created in 20A