SAP ABAP Class CL_SRM_DOCUMENT2 (Represents a Document in GSP 2)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-RM (Application Component) SAP Records Management
⤷
SRM_GENERIC_SP2 (Package) Generic SP 2 on GDMA
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SRM_DOCUMENT | GSP 2: Interface Document | 20030310 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SRM_GSP_PROPERTIES | Access to Document Attributes | 20030602 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_RMPS_DOCUMENT2 | RMPS: Represents a document in GSP 2 | 20030917 |
Properties
| Class | CL_SRM_DOCUMENT2 | |
| Short Description | Represents a Document in GSP 2 | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SRM_GENERIC_SP2 | Generic SP 2 on GDMA |
| Created | 20030310 | SAP |
| Last change | 00000000 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SRM_DOCUMENT | GSP 2: Interface Document | 20030310 | ||
| 2 | IF_SRM_GSP_PROPERTIES | Access to Document Attributes | 20030602 |
Friends
Class CL_SRM_DOCUMENT2 has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | STRING | 'KPro' | KPro as Repository | 20030602 | ||
| 2 | Constant | Public | Type reference (TYPE) | STRING | 'WebDAV' | WebDAV as Storage Repository | 20030602 | ||
| 3 | Constant | Public | Type reference (TYPE) | STRING | 'CL_SRM_DOCUMENT2' | SRC Class | 20030703 | ||
| 4 | Instance attribute | Protected | Type reference (TYPE) | SRMGS_BOOLEAN | Lock is set for mod. | 20030310 | |||
| 5 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_DM_ACCESS | Query GDMA Access Rights | 20030310 | |||
| 6 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_DM_DOCUMENT | GDMA Document Interface | 20030310 | |||
| 7 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_DM_LOCK | GDMA Locking of Documents | 20030310 | |||
| 8 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_DM_PROPERTIES | GDMA Document Properties | 20030310 | |||
| 9 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_DM_DOCUMENTS | GDMA Document Repository | 20030311 | |||
| 10 | Instance attribute | Protected | Type reference (TYPE) | STRING | GDMA Repository Application Space | 20030311 | |||
| 11 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_DM_VARIANT | GDMA Document Variant | 20030311 | |||
| 12 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_DM_VERSION | GDMA Document Version | 20030310 | |||
| 13 | Static Attribute | Private | Object reference (TYPE REF TO) | IF_EX_SRMGS_DOCUMENT | Document BADI | 20040308 | |||
| 14 | Static Attribute | Private | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | Flag: BADI loaded | 20040308 | ||
| 15 | Instance attribute | Protected | Type reference (TYPE) | STRING | Internal Document ID | 20030310 | |||
| 16 | Instance attribute | Protected | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | 'X': Do Commit | 20030603 | ||
| 17 | Instance attribute | Protected | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | 'X': Save Change on Update | 20030603 | ||
| 18 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_SRM_GENERIC_SP | Optional: Application Framework | 20030310 | |||
| 19 | Instance attribute | Protected | Type reference (TYPE) | STRING | Predefined Variant ID | 20030310 | |||
| 20 | Instance attribute | Protected | Type reference (TYPE) | STRING | Predefined Version ID | 20030310 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Protected | Method | Link to an Existing DB Instance | 20030310 | |
| 2 | Instance method | Protected | Method | Connect to GDMA Interfaces | 20030818 | |
| 3 | Instance method | Protected | Method | Init GDMA Repository | 20030818 | |
| 4 | Instance method | Public | Constructor | Constructor | 20030310 | |
| 5 | Instance method | Protected | Method | Create New Document DB Instance | 20030310 | |
| 6 | Instance method | Protected | Method | Create a New Version Object | 20030311 | |
| 7 | Static method | Protected | Method | Write an Entry in the Application Log | 20030317 | |
| 8 | Instance method | Protected | Method | 20030821 |
Events
Class CL_SRM_DOCUMENT2 has no event.
Types
Class CL_SRM_DOCUMENT2 has no local type.
Method Signatures
Method CONNECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DOC_ID | Call by reference | Type reference (TYPE) | STRING | ID des Dokoments | 20030310 | |||
| 2 | VARIANT | Call by reference | Type reference (TYPE) | STRING | ID der Variante | 20030310 | |||
| 3 | VERSION | Call by reference | Type reference (TYPE) | STRING | ID der Version | 20030310 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic SP2: Allgemeiner Fehler | 20030602 |
Method CONNECT_GDMA_DOC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | X_CREATE | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | 20030818 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic SP2: Allgemeiner Fehler | 20030818 |
Method CONNECT_GDMA_REP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DOC_PROVIDER_SPACE | Call by reference | Type reference (TYPE) | STRING | 20030827 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic SP2: Allgemeiner Fehler | 20030818 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CREATE | Call by reference | Type reference (TYPE) | SRMGS_BOOLEAN | ' ' | Soll ein neues Dokument erzeugt werden? | 20030310 | ||
| 2 | DM_REP | Call by reference | Object reference (TYPE REF TO) | CL_DM_DOCUMENTS | DM Repository | 20030818 | |||
| 3 | DOC_CLASS | Call by reference | Type reference (TYPE) | STRING | OBSOLETE: Dokumentklasse | 20030310 | |||
| 4 | DOC_ID | Call by reference | Type reference (TYPE) | STRING | Interne ID, |
20030310 | |||
| 5 | DOC_PROVIDER_SPACE | Call by reference | Type reference (TYPE) | STRING | GDMA-Application-Space | 20030826 | |||
| 6 | DO_COMMIT | Call by reference | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | Commit Ja/Nein | 20030310 | ||
| 7 | DO_UPDATE_TASK | Call by reference | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | Verbuchung Ja/Nein | 20030611 | ||
| 8 | PROPERTIES | Call by reference | Type reference (TYPE) | SRMGS_PROPERTY_TAB | Properties für das neue Dokumentklasse | 20030310 | |||
| 9 | USAGE_FRAMEWORK | Call by reference | Object reference (TYPE REF TO) | IF_SRM_GENERIC_SP | Generischer Service Provider RMS | 20030310 | |||
| 10 | VARIANT | Call by reference | Type reference (TYPE) | STRING | ID der Variante | 20030310 | |||
| 11 | VERSION | Call by reference | Type reference (TYPE) | STRING | ID der Version | 20030310 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic SP2: Allgemeiner Fehler | 20030602 |
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PROPERTIES | Call by reference | Type reference (TYPE) | SRMGS_PROPERTY_TAB | Properties für das neue Dokument | 20030310 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic SP2: Allgemeiner Fehler | 20030602 |
Method P_CREATE_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DM_DOC | Call by reference | Object reference (TYPE REF TO) | IF_DM_DOCUMENT | 20030602 | ||||
| 2 | OBJECT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_VERSION | Erzeugtes Objekt | 20030311 | |||
| 3 | VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | 20030311 | ||||
| 4 | VERSION_ID | Call by reference | Type reference (TYPE) | STRING | 20030311 |
Method P_CREATE_VERSION on class CL_SRM_DOCUMENT2 has no exception.
Method P_LOG_WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ALT_TEXT | Value transfer | Type reference (TYPE) | STRING | Alternativer Text | 20030317 | |||
| 2 | DO_COMMIT | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_TRUE | DB-Commit fuer Log | 20030317 | ||
| 3 | MSG_ID | Value transfer | Type reference (TYPE) | CHAR20 | 'SRM_GENERIC_SP' | Nachrichtenklasse | 20030317 | ||
| 4 | MSG_NO | Value transfer | Type reference (TYPE) | I | Meldungsnummer | 20030317 | |||
| 5 | MSG_TYPE | Value transfer | Type reference (TYPE) | C | 'E' | Nachrichtentyp | 20030317 | ||
| 6 | PROB_CLASS | Value transfer | Type reference (TYPE) | C | '2' | Problemklasse (1-4 -- 1: sehr wichtig) | 20030317 | ||
| 7 | VAR_1 | Value transfer | Type reference (TYPE) | STRING | Variable 1 | 20030317 | |||
| 8 | VAR_2 | Value transfer | Type reference (TYPE) | STRING | Variable 2 | 20030317 | |||
| 9 | VAR_3 | Value transfer | Type reference (TYPE) | STRING | Variable 3 | 20030317 | |||
| 10 | VAR_4 | Value transfer | Type reference (TYPE) | STRING | Variable 4 | 20030317 |
Method P_LOG_WRITE on class CL_SRM_DOCUMENT2 has no exception.
Method P_PROP_RESERVED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NAME | Value transfer | Type reference (TYPE) | CSEQUENCE | 20030821 | ||||
| 2 | RESERVED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20030821 |
Method P_PROP_RESERVED on class CL_SRM_DOCUMENT2 has no exception.
History
| Last changed by/on | SAP | 00000000 |
| SAP Release Created in | 640 |