SAP ABAP Class IF_SRM_DOCUMENT (GSP 2: Interface Document)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_SRM_DOCUMENT | Represents a Document | 20030708 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_SRM_DOCUMENT2 | Represents a Document in GSP 2 | 20030310 |
Properties
| Class | IF_SRM_DOCUMENT | |
| Short Description | GSP 2: Interface Document | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20030326 | SAP |
| Last change | 20090618 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  SRMGS |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class IF_SRM_DOCUMENT has no interface implemented.
Friends
Class IF_SRM_DOCUMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACT_CLOSE |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'CLOSE' | Close Activity Document | 20030924 | |
| 2 | ACT_CREATE |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'CREATE' | Activity: Creating Documents | 20030612 | |
| 3 | ACT_DELETE |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'DELETE' | 20030616 | ||
| 4 | ACT_MODIFY |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'MODIFY' | Activity: Write Access for Content | 20030612 | |
| 5 | ACT_MODIFY_PROPERTIES |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'MODIFY_PROPS' | 20040719 | ||
| 6 | ACT_REOPEN |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'REOPEN' | Open Activity Document | 20030925 | |
| 7 | ACT_SEARCH |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'SEARCH' | Activity: Find Document | 20030612 | |
| 8 | ACT_TRANSPORT |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'TRANSPORT' | 20030616 | ||
| 9 | ACT_VIEW |
Constant | Public | Type reference (TYPE) | SRMGS_ACTIVITY | 'VIEW' | Activity: Read Access to Content | 20030612 | |
| 10 | C_MAX_VERSION_NAME |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_MAX_VERSION' | Name of Property for Maximum Version Number of Document | 20030612 | |
| 11 | C_REPOSITORY_KPRO |
Constant | Public | Type reference (TYPE) | STRING | 'KPro' | 20030612 | ||
| 12 | C_REPOSITORY_WEBDAV |
Constant | Public | Type reference (TYPE) | STRING | 'WebDAV' | 20030612 | ||
| 13 | PROP_CONTENT_CHANGED_AT |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'LAST_CHANGED_AT' | Property Name: Content Last Changed On | 20030612 | |
| 14 | PROP_CONTENT_CHANGED_BY |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'LAST_CHANGED_BY' | Property Name: Content Last Changed By: | 20030612 | |
| 15 | PROP_CREATED_AT |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'CREATED_AT' | Property Name: Created On | 20030612 | |
| 16 | PROP_CREATED_BY |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'CREATED_BY' | Property Name: Created By | 20030612 | |
| 17 | PROP_DESCRIPTION |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'DESCRIPTION' | Property Name: Description Text | 20030612 | |
| 18 | PROP_DOCUMENT_ID |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_DOCUMENT_ID' | Property Name: Unique Identification | 20030612 | |
| 19 | PROP_DOC_STATE |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_DOCUMENT_STATE' | Property Name: Document Status | 20030612 | |
| 20 | PROP_FILEPLAN_POS |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_FILEPLAN_POS' | Property Name: Position in File Plan | 20030612 | |
| 21 | PROP_IS_TRANSPORTED |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_IS_TRANSPORTED' | Property Name: Document is Transported | 20030612 | |
| 22 | PROP_KEYWORD |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_KEYWORD' | Property Name: Keyword Catalog | 20030612 | |
| 23 | PROP_LOGICAL_VERSION |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_LOG_VERSION' | Property Name for Logical Version Number | 20030612 | |
| 24 | PROP_MODEL |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_MODEL' | Property Name: ID of Model From Which Document Originates | 20030612 | |
| 25 | PROP_MODEL_DOCID |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_MODEL_DOCID' | Property Name: Technical ID of Model | 20030612 | |
| 26 | PROP_PHYSICAL_VARIANT |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_VARIANT_ID' | Property Name: Physical Variant ID | 20030612 | |
| 27 | PROP_PHYSICAL_VERSION |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_VERSION_ID' | Property Name: Physical Version Number | 20030612 | |
| 28 | PROP_PROPS_CHANGED_AT |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_LAST_CHANGED_AT' | Property Name: Properties Last Changed On | 20030612 | |
| 29 | PROP_PROPS_CHANGED_BY |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_LAST_CHANGED_BY' | Property Name: Properties Last Changed By | 20030612 | |
| 30 | PROP_STATE |
Constant | Public | Type reference (TYPE) | SRMGS_PROP_NAME | 'SRM_STATE' | Property Name: Document Status | 20030811 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | APPLY_LOCK |
Instance method | Public | Method | Create Lock for this Document | 20030326 |
| 2 | COPY_PARTIAL |
Instance method | Public | Method | Copy a given version and variant to new document | 20030326 |
| 3 | CREATE_VERSION |
Instance method | Public | Method | Create New Version of Document | 20030326 |
| 4 | DELETE |
Instance method | Public | Method | Delete Document | 20030326 |
| 5 | FORCE_VERSION_RELOAD |
Instance method | Public | Method | Look on the DB at next version access | 20050414 |
| 6 | FREEZE_CURRENT_VERSION |
Instance method | Public | Method | Freeze Current Version | 20030326 |
| 7 | GET_COMMIT_MODE |
Instance method | Public | Method | Fetch Commit Mode | 20030326 |
| 8 | GET_DM_REPOSITORY |
Instance method | Public | Method | Fetch Repository from GDMA | 20030924 |
| 9 | GET_DOC_ID |
Instance method | Public | Method | Get Documentation ID | 20030326 |
| 10 | GET_PROPERTY_INTERFACE |
Instance method | Public | Method | Get Interface for Property Access | 20030821 |
| 11 | GET_REPOSITORY_TYPE |
Instance method | Public | Method | Get Repository Type | 20030603 |
| 12 | GET_TRANSPORT_INFOS |
Instance method | Public | Method | Get Transport Infos for Whole Document | 20030709 |
| 13 | GET_UPDATE_MODE |
Instance method | Public | Method | Get Update Mode | 20030602 |
| 14 | GET_VARIANT |
Instance method | Public | Method | Get Variant of the Document | 20030326 |
| 15 | GET_VERSION |
Instance method | Public | Method | Get a Version of the Document | 20030326 |
| 16 | GET_VERSIONS_INFO |
Instance method | Public | Method | Get Information on All Versions of a Document | 20030326 |
| 17 | IS_AUTHORIZED |
Instance method | Public | Method | Checks Whether User is Authorised for Particular Activities | 20030326 |
| 18 | IS_MODIFIABLE |
Instance method | Public | Method | Checks Whether Document May Be Modified (is locked or not) | 20030326 |
| 19 | NEW_VARIANT |
Instance method | Public | Method | Create New Version with New Variant | 20030326 |
| 20 | REMOVE_LOCK |
Instance method | Public | Method | Delete Lock for the Document | 20030326 |
| 21 | SET_COMMIT_MODE |
Instance method | Public | Method | Set Commit Mode | 20030602 |
| 22 | SET_UPDATE_MODE |
Instance method | Public | Method | Set Update Mode | 20030602 |
Events
Class IF_SRM_DOCUMENT has no event.
Types
Class IF_SRM_DOCUMENT has no local type.
Method Signatures
Method APPLY_LOCK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
LOCK_USER | Call by reference | Type reference (TYPE) | STRING | Anwender, der den Lock hält | 20030326 | ||
| 2 | Exporting |
SUCCESS | Call by reference | Type reference (TYPE) | SRMGS_BOOLEAN | 20030714 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method COPY_PARTIAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
DOC_OBJECT_ID_OF_COPY | Call by reference | Type reference (TYPE) | STRING | 20030825 | |||
| 2 | Exporting |
NEW_DOC_ID | Call by reference | Type reference (TYPE) | STRING | 20030708 | |||
| 3 | Importing |
VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | '-1' | 20030326 | ||
| 4 | Importing |
VERSION_ID | Call by reference | Type reference (TYPE) | STRING | '-1' | 20030326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method CREATE_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CREATE_NEW_LOG_VERSION | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | Neue logische Version anlegen? | 20030326 | |
| 2 | Exporting |
NEW_VERSION | Call by reference | Object reference (TYPE REF TO) | IF_SRM_VERSION | Die neue Version | 20030326 | ||
| 3 | Importing |
OLD_VERSION_ID | Value transfer | Type reference (TYPE) | STRING | SRMGS_C_ACTUAL_VERSION | DUMMY: Version, von der diese Version abgezweigt werden soll | 20030326 | |
| 4 | Importing |
PROPERTIES | Call by reference | Type reference (TYPE) | SRMGS_PROPERTY_TAB | Properties der neuen Version. | 20030326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
NO_CHECK | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | Berechtigungsprüfung umgehen | 20050207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method FORCE_VERSION_RELOAD Signature
Method FORCE_VERSION_RELOAD on class IF_SRM_DOCUMENT has no parameter.
Method FORCE_VERSION_RELOAD on class IF_SRM_DOCUMENT has no exception.
Method FREEZE_CURRENT_VERSION Signature
Method FREEZE_CURRENT_VERSION on class IF_SRM_DOCUMENT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method GET_COMMIT_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
DO_COMMIT | Value transfer | Type reference (TYPE) | SRMBOOLEAN | 20030326 |
Method GET_COMMIT_MODE on class IF_SRM_DOCUMENT has no exception.
Method GET_DM_REPOSITORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
DM_REP | Value transfer | Object reference (TYPE REF TO) | CL_DM_DOCUMENTS | 20030924 |
Method GET_DM_REPOSITORY on class IF_SRM_DOCUMENT has no exception.
Method GET_DOC_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
DOC_ID | Value transfer | Type reference (TYPE) | STRING | Dokumenten-ID | 20030326 |
Method GET_DOC_ID on class IF_SRM_DOCUMENT has no exception.
Method GET_PROPERTY_INTERFACE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
INTERFACE | Value transfer | Object reference (TYPE REF TO) | IF_SRM_GSP_PROPERTIES | 20030821 |
Method GET_PROPERTY_INTERFACE on class IF_SRM_DOCUMENT has no exception.
Method GET_REPOSITORY_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
REP_TYPE | Value transfer | Type reference (TYPE) | STRING | 20030603 |
Method GET_REPOSITORY_TYPE on class IF_SRM_DOCUMENT has no exception.
Method GET_TRANSPORT_INFOS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
TRANSPORT_INFOS | Call by reference | Type reference (TYPE) | SRMGS_COMMFILE_ENTRY_TAB | Tabelle mit Transportinformationen | 20030709 | ||
| 2 | Exporting |
TRANSPORT_INFOS2 | Call by reference | Type reference (TYPE) | SRMGS_COMMFILE_ENTRY_TAB2 | Zusatzinfos zum Transport | 20030709 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030709 |
Method GET_UPDATE_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
DO_UPDATE_TASK | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | 20030602 |
Method GET_UPDATE_MODE on class IF_SRM_DOCUMENT has no exception.
Method GET_VARIANT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
MY_VARIANT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_VARIANT | Variante | 20030326 | ||
| 2 | Importing |
TARGET_TIME | Call by reference | Type reference (TYPE) | TIMESTAMP | Stichzeitpunkt | 20030326 | ||
| 3 | Importing |
VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | SRMGS_C_PRESET_VALUE | ID der Variante | 20030326 | |
| 4 | Importing |
VERSION_ID | Call by reference | Type reference (TYPE) | STRING | SRMGS_C_PRESET_VALUE | ID der Version | 20030326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method GET_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
TARGET_TIME | Call by reference | Type reference (TYPE) | TIMESTAMP | Stichzeitpunkt | 20030326 | ||
| 2 | Returning |
VERSION | Value transfer | Object reference (TYPE REF TO) | IF_SRM_VERSION | Version | 20030326 | ||
| 3 | Importing |
VERSION_ID | Call by reference | Type reference (TYPE) | STRING | SRMGS_C_PRESET_VALUE | Versionsnummer | 20030326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method GET_VERSIONS_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PROPERTIES | Call by reference | Type reference (TYPE) | SRMGS_PROPERTY_TAB | Gewünschte Properties | 20030326 | ||
| 2 | Exporting |
VERSIONS | Call by reference | Type reference (TYPE) | SRMGS_OBJECT_TAB | Liste der Objekt-Properties | 20030326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method IS_AUTHORIZED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ACTIVITY | Value transfer | Type reference (TYPE) | SRMGS_ACTIVITY | Aktivität : Konstanten SRMGS_ACT* | 20030326 | ||
| 2 | Returning |
OK | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | Authorisation vorhanden? | 20030326 |
Method IS_AUTHORIZED on class IF_SRM_DOCUMENT has no exception.
Method IS_MODIFIABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
OPERATION | Call by reference | Type reference (TYPE) | CSEQUENCE | Operation, die durchgeführt werden soll | 20030326 | ||
| 2 | Returning |
RESULT | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | Ergebnis | 20030326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030616 |
Method NEW_VARIANT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CREATE_NEW_LOG_VERSION | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | Neue logische Version anlegen? | 20030326 | |
| 2 | Importing |
IM_IS_NEW_DOC | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | 20080821 | |||
| 3 | Returning |
NEW_VARIANT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_VARIANT | Neue Variante | 20030326 | ||
| 4 | Importing |
OLD_VARIANT_ID | Value transfer | Type reference (TYPE) | STRING | SRMGS_C_PRESET_VALUE | Alte Variante, von der diese abgeleitet | 20030326 | |
| 5 | Importing |
PROPERTIES | Value transfer | Type reference (TYPE) | SRMGS_PROPERTY_TAB | Eigenschaften | 20030326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method REMOVE_LOCK Signature
Method REMOVE_LOCK on class IF_SRM_DOCUMENT has no parameter.
Method REMOVE_LOCK on class IF_SRM_DOCUMENT has no exception.
Method SET_COMMIT_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DO_COMMIT | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | 20030602 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
Method SET_UPDATE_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DO_UPDATE_TASK | Call by reference | Type reference (TYPE) | SRMGS_BOOLEAN | Commit Ja/Nein | 20030602 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Generic SP2: Allgemeiner Fehler | 20030602 |
History
| Last changed by/on | SAP | 20090618 |
| SAP Release Created in |
