SAP ABAP Interface IF_CFX_VERSIONING (Common Interface for All Versional 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 implementation (CLASS c. INTERFACES i_ref) | CL_CFX_COMMON_DOCUMENT | General Document Class | 20041108 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CFX_DATA_SHEET | Specification Data Sheet | 20001206 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CFX_GENERIC_OBJECT | Folder Object Generic Object in cFolders | 20030121 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CFX_MATERIAL | Material in cFolders | 20020222 |
| 5 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CFX_STRUCTURE | BOM Header | 20020225 |
| 6 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CFX_TEXT | XML-Based Continuous Text | 20001205 |
Properties
| Interface | IF_CFX_VERSIONING | |
| Short Description | Common Interface for All Versional 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_CFX_DOCUMENT | Common Interface for All Documents | 20011030 |
Friends
Interface IF_CFX_VERSIONING has no friend.
Attributes
Interface IF_CFX_VERSIONING has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Checks Whether Content Can Be Changed | 20011102 | |
| 2 | Instance method | Public | Method | Returns Access Info | 20010907 | |
| 3 | Instance method | Public | Method | Returns List of Back-End Systems | 20020515 | |
| 4 | Instance method | Public | Method | Returns the ID of the Current Version | 20010205 | |
| 5 | Instance method | Public | Method | Reads Locking User of Current Version | 20010910 | |
| 6 | Instance method | Public | Method | Reads Description of Version | 20001204 | |
| 7 | Instance method | Public | Method | Delivers ID of Last Version Which Came from Backend | 20020315 | |
| 8 | Instance method | Public | Method | Reads Names of a Version | 20010117 | |
| 9 | Instance method | Public | Method | Reads URL Depending on Version | 20001113 | |
| 10 | Instance method | Public | Method | Reads Version Overview | 20001113 | |
| 11 | Instance method | Public | Method | Reads Version Overview | 20011102 | |
| 12 | Instance method | Public | Method | Locks Current Version | 20010910 | |
| 13 | Instance method | Public | Method | Reads File Content | 20001110 | |
| 14 | Instance method | Public | Method | Sets the Backend Namespace | 20020319 | |
| 15 | Instance method | Public | Method | Sets Description of Version | 20001204 | |
| 16 | Instance method | Public | Method | Sets Name of Version | 20010117 | |
| 17 | Instance method | Public | Method | Saves Info That User Has Accessed Version | 20011126 | |
| 18 | Instance method | Public | Method | Unlocks Current Version | 20010910 | |
| 19 | Instance method | Public | Method | Writes File Content | 20001110 | |
| 20 | Instance method | Public | Method | Writes File Contents Without Authorization Check | 20030313 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | VERSION_CREATED | Instance Event (0) |
Public (2) |
A Version Has Been Created | 20010705 |
Types
Interface IF_CFX_VERSIONING has no local type.
Method Signatures
Method CONTENT_IS_CHANGEABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_VERS_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20011102 | |||
| 2 | R_IS_CHANGEABLE | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | Boolscher Typ | 20011109 |
Method CONTENT_IS_CHANGEABLE on Interface IF_CFX_VERSIONING has no exception.
Method GET_ACCESS_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_USER | Call by reference | Object reference (TYPE REF TO) | CL_CFX_USER | Benutzer | 20010907 | |||
| 2 | I_VERSION_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20010910 | |||
| 3 | RT_ACCESS_INFO | Value transfer | Type reference (TYPE) | CFX_TT_ACCESS | Zugriffs Info | 20010910 |
Method GET_ACCESS_INFO on Interface IF_CFX_VERSIONING has no exception.
Method GET_BACKEND_SYSTEMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_BACKEND_SYSTEM | Call by reference | Type reference (TYPE) | CFX_TT_STRING | Liste der Backend Systeme | 20050314 | |||
| 2 | I_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | ID der Version | 20020515 |
Method GET_BACKEND_SYSTEMS on Interface IF_CFX_VERSIONING has no exception.
Method GET_CURRENT_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_CURRENT_VERSION | Value transfer | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20010205 |
Method GET_CURRENT_VERSION on Interface IF_CFX_VERSIONING has no exception.
Method GET_CURRENT_VERSION_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 | 20010910 |
Method GET_CURRENT_VERSION_LOCK_USER on Interface IF_CFX_VERSIONING has no exception.
Method GET_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20001204 | |||
| 2 | R_DESCRIPTION | Value transfer | Type reference (TYPE) | STRING | Beschreibung der Version | 20001204 |
Method GET_DESCRIPTION on Interface IF_CFX_VERSIONING has no exception.
Method GET_LAST_BACKEND_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_BACKEND_SYSTEM | Call by reference | Type reference (TYPE) | CFX_STRING | Namespace des Backendsystems | 20020415 | |||
| 2 | R_LAST_BACKEND_VERSION_ID | Value transfer | Type reference (TYPE) | GUID_32 | ID der letzten Backend Version | 20020315 |
Method GET_LAST_BACKEND_VERSION on Interface IF_CFX_VERSIONING has no exception.
Method GET_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20010117 | |||
| 2 | R_NAME | Value transfer | Type reference (TYPE) | SDOK_PROPV | Attributausprägung | 20010117 |
Method GET_NAME on Interface IF_CFX_VERSIONING has no exception.
Method GET_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_URL | Call by reference | Type reference (TYPE) | STRING | 20020321 | ||||
| 2 | E_VER_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20020321 | |||
| 3 | I_ABS_URL | Call by reference | Type reference (TYPE) | STRING | 20020304 | ||||
| 4 | I_FOR_LOCATION | Call by reference | Type reference (TYPE) | SDOK_LOC | Lokation als Verteilungskriterium | 20020422 | |||
| 5 | I_VER_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20020321 |
Method GET_URL on Interface IF_CFX_VERSIONING has no exception.
Method GET_VERSION_OVERVIEW Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_VERSIONS | Call by reference | Type reference (TYPE) | CFX_TT_VERSION_OVERVIEW | Versionsüberblick für ein Dokument | 20001113 | |||
| 2 | I_WITHFILENAME | Call by reference | Type reference (TYPE) | CFX_BOOLEAN | ' ' | Boolscher Typ | 20001206 |
Method GET_VERSION_OVERVIEW on Interface IF_CFX_VERSIONING has no exception.
Method GET_VERSION_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_PROPS | Call by reference | Type reference (TYPE) | CFX_TS_VERSION_OVERVIEW | Zeile im Versionsüberblick für ein Dokument | 20011102 | |||
| 2 | I_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20011102 | |||
| 3 | I_WITHFILENAME | Call by reference | Type reference (TYPE) | CFX_BOOLEAN | ' ' | Boolscher Typ | 20011102 |
Method GET_VERSION_PROPERTIES on Interface IF_CFX_VERSIONING has no exception.
Method LOCK_CURRENT_VERSION Signature
Method LOCK_CURRENT_VERSION on Interface IF_CFX_VERSIONING has no parameter.
Method LOCK_CURRENT_VERSION on Interface IF_CFX_VERSIONING has no exception.
Method READ_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_RAW_CONTENT | Call by reference | Type reference (TYPE) | SDOKCNTBINS | SDOK: Tabelle von Binärdokumentinhalten für den Webserver | 20001114 | |||
| 2 | E_FILE_SIZE | Call by reference | Type reference (TYPE) | I | Größe des Files | 20001116 | |||
| 3 | E_LOCAL_FILENAME | Call by reference | Type reference (TYPE) | SDOK_FILNM | Relativer Ablageort eines physischen Dokuments | 20001110 | |||
| 4 | E_MIMETYPE | Call by reference | Type reference (TYPE) | W3CONTTYPE | HTML-Content-Type | 20001114 | |||
| 5 | I_TRACK_ACCESS | Call by reference | Type reference (TYPE) | CFX_BOOLEAN | ABAP_TRUE | Boolscher Typ | 20011129 | ||
| 6 | I_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20001110 |
Method READ_CONTENT on Interface IF_CFX_VERSIONING has no exception.
Method SET_BACKEND_SYSTEM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_BACKEND_SYSTEM | Call by reference | Type reference (TYPE) | CFX_STRING | Namespace des Beackends | 20020319 | |||
| 2 | I_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20020319 |
Method SET_BACKEND_SYSTEM on Interface IF_CFX_VERSIONING 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 der Version | 20001204 | |||
| 2 | I_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20001204 |
Method SET_DESCRIPTION on Interface IF_CFX_VERSIONING 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) | SDOK_PROPV | Attributausprägung | 20010117 | |||
| 2 | I_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20010117 |
Method SET_NAME on Interface IF_CFX_VERSIONING has no exception.
Method TRACK_USER_ACCESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_VER_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20011126 |
Method TRACK_USER_ACCESS on Interface IF_CFX_VERSIONING has no exception.
Method UNLOCK_CURRENT_VERSION Signature
Method UNLOCK_CURRENT_VERSION on Interface IF_CFX_VERSIONING has no parameter.
Method UNLOCK_CURRENT_VERSION on Interface IF_CFX_VERSIONING has no exception.
Method WRITE_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_NEWGUID | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20001214 | |||
| 2 | E_NEW_VERSION | Call by reference | Type reference (TYPE) | ABAP_BOOL | Wurde eine neue Version angelegt ? | 20020319 | |||
| 3 | E_NUMBER_OF_VERSIONS | Call by reference | Type reference (TYPE) | I | Zahl der Versionen, aber NUR falls neue Version erzeugt wird | 20010706 | |||
| 4 | E_STORAGE_CATEGORY | Call by reference | Type reference (TYPE) | SDOK_STCAT | Kategorie für physische Dokumente | 20020418 | |||
| 5 | IT_RAW_CONTENT | Call by reference | Type reference (TYPE) | SDOKCNTBINS | SDOK: Tabelle von Binärdokumentinhalten für den Webserver | 20001110 | |||
| 6 | I_FILE_SIZE | Call by reference | Type reference (TYPE) | I | Größe des Files | 20001116 | |||
| 7 | I_FORCE_KEEP_VERSION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | In jedem Fall alte Version beibehalten | 20050207 | ||
| 8 | I_IGNORE_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | If the copy mode is activated, ignore the blacklist check | 20090619 | |||
| 9 | I_LOCAL_FILENAME | Call by reference | Type reference (TYPE) | SDOK_FILNM | Relativer Ablageort eines physischen Dokuments | 20001110 | |||
| 10 | I_MIMETYPE | Call by reference | Type reference (TYPE) | W3CONTTYPE | HTML-Content-Type | 20001114 | |||
| 11 | I_NEW_VERSION | Call by reference | Type reference (TYPE) | ABAP_BOOL | Soll neue Version angelegt werden ? | 20001113 | |||
| 12 | I_USE_PHIO_FOR_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20020328 | |||
| 13 | I_VERSION_NAME | Call by reference | Type reference (TYPE) | SDOK_PROPV | Name der Version | 20010111 |
Method WRITE_CONTENT on Interface IF_CFX_VERSIONING has no exception.
Method WRITE_CONTENT_NO_CHECKS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_NEWGUID | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20030313 | |||
| 2 | E_NEW_VERSION | Call by reference | Type reference (TYPE) | ABAP_BOOL | Wurde eine neue Version angelegt ? | 20030313 | |||
| 3 | E_NUMBER_OF_VERSIONS | Call by reference | Type reference (TYPE) | I | Zahl der Versionen, aber NUR falls neue Version erzeugt wird | 20030313 | |||
| 4 | E_STORAGE_CATEGORY | Call by reference | Type reference (TYPE) | SDOK_STCAT | Kategorie für physische Dokumente | 20030313 | |||
| 5 | IT_RAW_CONTENT | Call by reference | Type reference (TYPE) | SDOKCNTBINS | SDOK: Tabelle von Binärdokumentinhalten für den Webserver | 20030313 | |||
| 6 | I_FILE_SIZE | Call by reference | Type reference (TYPE) | I | Größe des Files | 20030313 | |||
| 7 | I_FORCE_KEEP_VERSION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | In jedem Fall alte Version beibehalten | 20050207 | ||
| 8 | I_LOCAL_FILENAME | Call by reference | Type reference (TYPE) | SDOK_FILNM | Relativer Ablageort eines physischen Dokuments | 20030313 | |||
| 9 | I_MIMETYPE | Call by reference | Type reference (TYPE) | W3CONTTYPE | HTML-Content-Type | 20030313 | |||
| 10 | I_NEW_VERSION | Call by reference | Type reference (TYPE) | ABAP_BOOL | Soll neue Version angelegt werden ? | 20030313 | |||
| 11 | I_USE_PHIO_FOR_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | GUID im 'CHAR' Format in Großschreibung | 20030313 | |||
| 12 | I_VERSION_NAME | Call by reference | Type reference (TYPE) | SDOK_PROPV | Name der Version | 20030313 |
Method WRITE_CONTENT_NO_CHECKS on Interface IF_CFX_VERSIONING has no exception.
Event Signatures
Event VERSION_CREATED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NUMBER_OF_VERSIONS | Exporting | Value transfer | Type reference (TYPE) | I | 20010706 |
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 20A |