SAP ABAP Class IF_CFX_DOCUMENT (Common Interface for All Documents)
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | IF_ACO_COMMON | Common Interface for Authorization Check | 20020423 |
| 2 | Interface composition (i COMPRISING i_ref) | IF_CFX_ALIAS | Alias Names for Objects | 20010613 |
| 3 | Interface composition (i COMPRISING i_ref) | IF_CFX_COMMON | Common Interface for All Objects | 20010808 |
| 4 | Interface composition (i COMPRISING i_ref) | IF_CFX_DOCUMENT_HELP | Help Interface for IF_CFX_DOCUMENT | 20090617 |
| 5 | Interface composition (i COMPRISING i_ref) | IF_CFX_GO_DATA_PARENT | Object Interface for Object with Generic Data | 20030130 |
| 6 | Interface composition (i COMPRISING i_ref) | IF_CFX_ITERATOR_ELEMENT | Common Interface for All Objects That Can Be Iterated | 20001108 |
Meta Relationship - Used By
Properties
| Class | IF_CFX_DOCUMENT | |
| Short Description | Common Interface for All Documents | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20001107 | SAP |
| Last change | 20141109 | |
| 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) |
Interfaces
Class IF_CFX_DOCUMENT has no interface implemented.
Friends
Class IF_CFX_DOCUMENT has no friend class.
Attributes
Class IF_CFX_DOCUMENT has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Can Both Documents Belong to the Same BOM? | 20020424 | |
| 2 | Instance method | Public | Method | Generate Copy | 20001107 | |
| 3 | Instance method | Public | Method | Delete | 20001107 | |
| 4 | Instance method | Public | Method | Delete Without Check | 20020723 | |
| 5 | Instance method | Public | Method | Freezing of Document | 20001107 | |
| 6 | Instance method | Public | Method | Return Authority Object | 20001218 | |
| 7 | Instance method | Public | Method | Return Copied Document | 20001205 | |
| 8 | Instance method | Public | Method | Return Copy Source | 20001205 | |
| 9 | Instance method | Public | Method | Description | 20001109 | |
| 10 | Instance method | Public | Method | Return the 32-Digit GUID to SKWF_10 | 20001117 | |
| 11 | Instance method | Public | Method | Determines the Locking User or Initial for No Lock | 20001127 | |
| 12 | Instance method | Public | Method | Names | 20001109 | |
| 13 | Instance method | Public | Method | Superordinate Folder | 20001109 | |
| 14 | Instance method | Public | Method | Delivers Characteristics for Document | 20010907 | |
| 15 | Instance method | Public | Method | URL of Document | 20001107 | |
| 16 | Instance method | Public | Method | Determines If Document is Frozen | 20001218 | |
| 17 | Instance method | Public | Method | Reads Master Flag from Properties | 20020325 | |
| 18 | Instance method | Public | Method | Is Document Persistent (in SKWF)? | 20020419 | |
| 19 | Instance method | Public | Method | Locking of Document | 20001107 | |
| 20 | Instance method | Public | Method | Drag Document to a New Target Foldder | 20001107 | |
| 21 | Instance method | Public | Method | Save Non-Persistent Object | 20020419 | |
| 22 | Instance method | Public | Method | Change Description | 20001107 | |
| 23 | Instance method | Public | Method | Sets Master Flag in Properties | 20020325 | |
| 24 | Instance method | Public | Method | Change name | 20001107 | |
| 25 | 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
Class 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 | IP_COMMON | Call by reference | Object reference (TYPE REF TO) | IF_CFX_COMMON | Gemeinsame Schnittstelle aller Dokumente | 20031205 | |||
| 2 | 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 class IF_CFX_DOCUMENT has no exception.
Method COPY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_CLEANUP_DIRECTLY | Call by reference | Type reference (TYPE) | CFX_BOOLEAN | ABAP_FALSE | Sollen cleanup Methoden aufgerufen werden? | 20020508 | ||
| 2 | I_DESTINATION_FOLDER | Call by reference | Object reference (TYPE REF TO) | CL_CFX_COMMON_FOLDER | Mappe für Collaboration Folders | 20001114 | |||
| 3 | I_NAME | Call by reference | Type reference (TYPE) | STRING | 20001114 | ||||
| 4 | I_RAISE_EVENT | Call by reference | Type reference (TYPE) | CFX_BOOLEAN | ABAP_TRUE | Boolscher Typ | 20010712 | ||
| 5 | RP_DOCUMENT_COPY | Value transfer | Object reference (TYPE REF TO) | IF_CFX_DOCUMENT | Referenz auf kopiertes Objekt | 20001205 |
Method COPY on class IF_CFX_DOCUMENT has no exception.
Method DELETE Signature
Method DELETE on class IF_CFX_DOCUMENT has no parameter.
Method DELETE on class 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 | I_CHECK_SKWF_ERROR | Call by reference | Type reference (TYPE) | CFX_BOOLEAN | ABAP_TRUE | Boolscher Typ | 20020723 |
Method DELETE_WITHOUT_CHECK on class IF_CFX_DOCUMENT has no exception.
Method FREEZE Signature
Method FREEZE on class IF_CFX_DOCUMENT has no parameter.
Method FREEZE on class 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 | RP_AUTHORITY | Value transfer | Object reference (TYPE REF TO) | CL_CFX_AUTHORITY | Collaboration: Authority | 20001218 |
Method GET_AUTHORITY on class 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 | 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 class 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 | RP_COPY_SOURCE | Value transfer | Object reference (TYPE REF TO) | IF_CFX_DOCUMENT | Gemeinsame Schnittstelle aller Dokumente | 20001205 |
Method GET_COPY_SOURCE on class 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 | R_DESCRIPTION | Value transfer | Type reference (TYPE) | STRING | Beschreibung eines Dokuments | 20001109 |
Method GET_DESCRIPTION on class 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 | R_GUID | Value transfer | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20001117 |
Method GET_ID on class 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 | R_LOCK_USER | Value transfer | Type reference (TYPE) | CFX_USERID | Sperrender User oder initial | 20001127 |
Method GET_LOCK_USER on class 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 | R_NAME | Value transfer | Type reference (TYPE) | CFX_DOCUMENT_NAME | Name eine Dokuments | 20001109 |
Method GET_NAME on class 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 | 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 class 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 | E_CHANGED_BY | Call by reference | Type reference (TYPE) | SYUNAME | Anmeldename des Benutzers | 20010907 | |||
| 2 | E_CHANGED_BY_FULLNAME | Call by reference | Type reference (TYPE) | STRING | 20010907 | ||||
| 3 | E_CHANGED_ON_LOCAL_STR | Call by reference | Type reference (TYPE) | STRING | 20010907 | ||||
| 4 | E_CHANGED_ON_UTC | Call by reference | Type reference (TYPE) | TZNTSTMPS | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20010907 | |||
| 5 | E_CREATED_BY | Call by reference | Type reference (TYPE) | SYUNAME | Anmeldename des Benutzers | 20010907 | |||
| 6 | E_CREATED_BY_FULLNAME | Call by reference | Type reference (TYPE) | STRING | 20010907 | ||||
| 7 | E_CREATED_ON_LOCAL_STR | Call by reference | Type reference (TYPE) | STRING | 20010907 | ||||
| 8 | E_CREATED_ON_UTC | Call by reference | Type reference (TYPE) | TZNTSTMPS | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20010907 |
Method GET_PROPERTIES on class 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 | R_URL | Value transfer | Type reference (TYPE) | STRING | globale URL des Dokuments | 20001127 |
Method GET_URL on class 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 | R_IS_FROZEN | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | Boolscher Typ | 20001218 |
Method IS_FROZEN on class 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 | R_MASTER | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | Boolscher Typ | 20020325 |
Method IS_MASTER on class 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 | R_IS_NOT_PERSISTENT | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | Boolscher Typ | 20020419 |
Method IS_NOT_PERSISTENT on class IF_CFX_DOCUMENT has no exception.
Method LOCK Signature
Method LOCK on class IF_CFX_DOCUMENT has no parameter.
Method LOCK on class IF_CFX_DOCUMENT has no exception.
Method MOVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DESTINATION_FOLDER | Call by reference | Object reference (TYPE REF TO) | CL_CFX_COMMON_FOLDER | Mappe für Collaboration Folders | 20001114 |
Method MOVE on class IF_CFX_DOCUMENT has no exception.
Method SAVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_NEW_ID | Value transfer | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20020419 |
Method SAVE on class 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 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | STRING | Beschreibung eines Dokuments | 20001109 |
Method SET_DESCRIPTION on class 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 | I_MASTER | Call by reference | Type reference (TYPE) | CFX_BOOLEAN | KW Framework: Objektschlüssel | 20020325 |
Method SET_MASTER on class 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 | I_NAME | Call by reference | Type reference (TYPE) | CFX_DOCUMENT_NAME | Name eine Dokuments | 20001109 |
Method SET_NAME on class IF_CFX_DOCUMENT has no exception.
Method UNLOCK Signature
Method UNLOCK on class IF_CFX_DOCUMENT has no parameter.
Method UNLOCK on class IF_CFX_DOCUMENT has no exception.
Event Signatures
Event BEFORE_COPY Signature
Event BEFORE_COPY on class IF_CFX_DOCUMENT has no parameter.
Event COPIED Signature
Event COPIED on class IF_CFX_DOCUMENT has no parameter.
Event DELETED Signature
Event DELETED on class IF_CFX_DOCUMENT has no parameter.
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in |