SAP ABAP Class CL_SRM_SP_DOCUMENT (Represents SP Document)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-RM (Application Component) SAP Records Management
⤷
SRM_GENERAL_SP (Package) SRM General SPs
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-RM (Application Component) SAP Records Management⤷
SRM_GENERAL_SP (Package) SRM General SPsMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SRM_GENERIC_SP0 | Generic Service Provider RMS | 20031205 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_RCM_SP_DOC_PDF_FORM | SP Doc: Adobe PDF Form Handling | 20050330 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SRM_SP_DOCUMENT | Document API | 20030902 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SRM_SP_REFERENCE | Access to Unique Indicator | 20030902 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_HRASR00_SP_DOCUMENT | Document - Enhancement Auth. HR Admin. Services | 20040910 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_RMPS_SP_DOCUMENT | RMPS: Enhancements SP Document (BE) | 20021010 |
Properties
| Class | CL_SRM_SP_DOCUMENT | |
| Short Description | Represents SP Document | |
| Super Class | CL_SRM_GENERIC_SP0 | Generic Service Provider RMS |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SRM_GENERAL_SP | SRM General SPs |
| Created | 20030902 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  IF_SRM |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 2 | IF_SRM_GENSP_QUERY_EXT |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | SRMGS |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 4 | SRMGU |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_RCM_SP_DOC_PDF_FORM | SP Doc: Adobe PDF Form Handling | 20050330 | ||
| 2 | IF_SRM_SP_DOCUMENT | Document API | 20030902 | ||
| 3 | IF_SRM_SP_REFERENCE | Access to Unique Indicator | 20030902 |
Friends
Class CL_SRM_SP_DOCUMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_CONN_PARA_DOC_DOWNLOAD |
Constant | Public | Type reference (TYPE) | STRING | 'DOCUMENT_DOWNLOAD' | Connection Parameter 'DOCUMENT_DOWNLOAD' | 20080109 | |
| 2 | C_CONN_PARA_FUNC_GET_FORM_DATA |
Constant | Public | Type reference (TYPE) | STRING | 'FUNCTION_GET_FORM_DATA' | Connection Parameter | 20030902 | |
| 3 | C_CONN_PARA_TEMPLATE_ID |
Constant | Public | Type reference (TYPE) | STRING | 'TEMPLATE_ID' | Connection Parameter 'TEMPLATE_ID' | 20030902 | |
| 4 | C_CONN_SKIP_UNIQUEID_CHECK |
Constant | Public | Type reference (TYPE) | STRING | 'SKIP_UNIQUE_ID_CHECK' | Additional Uniqueness Check for "Unique ID" | 20130507 | |
| 5 | C_CONN_WEBDAV_NAME_ATTR_INPUT |
Constant | Public | Type reference (TYPE) | STRING | 'WEBDAV_NAME_ATTRIBUTE_INPUT' | 20090428 | ||
| 6 | C_CONN_WEBDAV_NAME_ATTR_OUTPUT |
Constant | Private | Type reference (TYPE) | STRING | 'WEBDAV_NAME_ATTRIBUTE_OUTPUT' | 20090428 | ||
| 7 | MY_COMMIT_MODE |
Instance attribute | Protected | Type reference (TYPE) | SRMBOOLEAN | Boolean: Possible Values IF_SRM=>TRUE / FALSE | 20030902 | ||
| 8 | MY_GSP_DOC_LOCKED_BY_ME |
Instance attribute | Protected | Type reference (TYPE) | SRMGS_BOOLEAN | 'X': Lock Is Set from Separate Class | 20030902 | ||
| 9 | MY_LOCK_USER |
Instance attribute | Protected | Type reference (TYPE) | STRING | User Currently Locking the Document | 20030902 | ||
| 10 | MY_OPEN_FOR_UPDATE |
Instance attribute | Protected | Type reference (TYPE) | SRMBOOLEAN | IF_SRM=>FALSE | 'X': Doc is Opened for Update | 20030902 | |
| 11 | MY_PROTO_HANDLER |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_SRM_SP_PROTOCOL_ENTRY | Read/Write SRM Log Entries | 20030902 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_DOC_STATE_INFO |
Instance method | Protected | Method | Get Status Info.: Completed, Checked Out? | 20030902 |
| 2 | CHECK_IF_DOC_IS_ACTUAL |
Instance method | Protected | Method | Checks if the Document is Current Version | 20030902 |
| 3 | CONN_PARA_TEMPLATE_ID_GET |
Instance method | Public | Method | Returns Values of the Connection Parameter 'TEMPLATE_ID' | 20030902 |
| 4 | GET_FLAG_RAISE_WF_EVENT |
Instance method | Public | Method | 20030902 | |
| 5 | GET_FUNCTION_GET_FORM_DATA |
Instance method | Public | Method | Get Connection Parameter 'FUNCTION_GET_FORM_DATA' | 20030902 |
| 6 | GET_LANGUAGE_PROPERTY |
Instance method | Protected | Method | Generate Property Line 'LANGUAGE' | 20030902 |
| 7 | GET_VARIANT |
Instance method | Protected | Method | 20030902 | |
| 8 | RAISE_SRM_STATE_EVENT |
Instance method | Public | Method | Trigger the Workflow event defined in status management | 20050427 |
| 9 | RAISE_WF_EVENT |
Instance method | Protected | Method | Trigger Workflow Event | 20030902 |
| 10 | WRITE_PROTOCOL |
Instance method | Protected | Method | Write Log for Performed Activities | 20030902 |
Events
Class CL_SRM_SP_DOCUMENT has no event.
Types
Class CL_SRM_SP_DOCUMENT has no local type.
Method Signatures
Method CHECK_DOC_STATE_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EX_CHECKED_OUT_BY | Value transfer | Type reference (TYPE) | STRING | 20030902 | |||
| 2 | Exporting |
EX_IS_FROZEN | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE | 20030902 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SRM_DOCUMENT_CLIENT |
Document Client | 20030902 |
Method CHECK_IF_DOC_IS_ACTUAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RE_IS_ACTUAL_VERSION | Value transfer | Type reference (TYPE) | SRMBOOLEAN | true wenn Version aktuell (=0) ist | 20030902 |
Method CHECK_IF_DOC_IS_ACTUAL on class CL_SRM_SP_DOCUMENT has no exception.
Method CONN_PARA_TEMPLATE_ID_GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_TEMPLATE_ID_TAB | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID_TAB | Liste verwendbarer Dokumentvorlagen | 20030902 |
Method CONN_PARA_TEMPLATE_ID_GET on class CL_SRM_SP_DOCUMENT has no exception.
Method GET_FLAG_RAISE_WF_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_RAISE_EVENT | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE | 20030902 |
Method GET_FLAG_RAISE_WF_EVENT on class CL_SRM_SP_DOCUMENT has no exception.
Method GET_FUNCTION_GET_FORM_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_FUNCTION_ID | Value transfer | Type reference (TYPE) | STRING | Function Id for user exit setting form data | 20030902 |
Method GET_FUNCTION_GET_FORM_DATA on class CL_SRM_SP_DOCUMENT has no exception.
Method GET_LANGUAGE_PROPERTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_PROPERTY | Value transfer | Type reference (TYPE) | SRMGS_PROPERTY | language property | 20030902 |
Method GET_LANGUAGE_PROPERTY on class CL_SRM_SP_DOCUMENT has no exception.
Method GET_VARIANT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_VARIANT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_VARIANT | 20030902 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP |
Document Client | 20030902 |
Method RAISE_SRM_STATE_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IM_CURSTATUSID | Call by reference | Type reference (TYPE) | SRMSTATID | SRM Status ID | 20050427 | ||
| 2 | Importing |
IM_DO_COMMIT | Call by reference | Type reference (TYPE) | SRMBOOLEAN | IF_SRM=>FALSE | Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE | 20050427 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_DOCUMENT_CLIENT |
Document Client | 20050427 |
Method RAISE_WF_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_DO_COMMIT | Call by reference | Type reference (TYPE) | SRMBOOLEAN | IF_SRM=>TRUE | Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE | 20030902 | |
| 2 | Importing |
IM_EVT_CONTAINER | Call by reference | Type reference (TYPE) | SRMGU_WF_CONTAINER | 20030902 | |||
| 3 | Importing |
IM_EVT_NAME | Call by reference | Type reference (TYPE) | STRING | 20030902 | |||
| 4 | Importing |
IM_OBJ_TYPE | Call by reference | Type reference (TYPE) | STRING | 'DOCUMENT' | 20030902 |
Method RAISE_WF_EVENT on class CL_SRM_SP_DOCUMENT has no exception.
Method WRITE_PROTOCOL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_ACTIVITY | Value transfer | Type reference (TYPE) | STRING | Activity ID | 20030902 | ||
| 2 | Importing |
IM_ARG1 | Value transfer | Type reference (TYPE) | STRING | 20030902 | |||
| 3 | Importing |
IM_ARG2 | Value transfer | Type reference (TYPE) | STRING | 20030902 | |||
| 4 | Importing |
IM_ARG_STR | Value transfer | Type reference (TYPE) | STRING | 20030902 | |||
| 5 | Importing |
IM_DISPLAY_NAME | Call by reference | Type reference (TYPE) | STRING | Anzeige Name | 20081120 |
Method WRITE_PROTOCOL on class CL_SRM_SP_DOCUMENT has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 640 |
