SAP ABAP Class /RPM/CL_DOCUMENT_SERVICES (General Services for Using Documents)
Hierarchy
☛
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
⤷
PPM-PFM (Application Component) Portfolio Management
⤷
/RPM/DOCUMENT (Package) RPM Document Objects
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0⤷
PPM-PFM (Application Component) Portfolio Management⤷
/RPM/DOCUMENT (Package) RPM Document ObjectsProperties
| Class | /RPM/CL_DOCUMENT_SERVICES | |
| Short Description | General Services for Using Documents | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /RPM/DOCUMENT | RPM Document Objects |
| Created | 20080603 | SAP |
| Last change | 20141109 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  /RPM/CL_CO |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class /RPM/CL_DOCUMENT_SERVICES has no interface implemented.
Friends
Class /RPM/CL_DOCUMENT_SERVICES has no friend class.
Attributes
Class /RPM/CL_DOCUMENT_SERVICES has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | DELETE_ALL_DOCS_IN_T_AREA |
Static method | Public | Method | Deletes all Documents in a Template Area | 20080929 |
| 2 | EDMS_APPL_PLUGIN_DO_INIT |
Static method | Private | Method | Initialization | 20080929 |
| 3 | EDMS_APPL_PLUGIN_GET_DOCUMENTS |
Static method | Private | Method | Retrieve Documents | 20080929 |
| 4 | GET_DOCUMENTS |
Static method | Public | Method | Reads Document Collection for RPM Objects | 20080603 |
| 5 | GET_DOCUMENT_BY_GUID |
Static method | Public | Method | Reads Reference from EDMS Collection for a GUID | 20080603 |
| 6 | GET_EDMS_DOCUMENT_SINGLE |
Static method | Public | Method | Select single document with EDMS GUID | 20080603 |
| 7 | GET_ENTITY_OF_DOC_DB |
Static method | Public | Method | Determine Entity for Document | 20080603 |
| 8 | GET_PPM_DOCUMENT_BY_GUID |
Static method | Public | Method | Reads Reference from EDMS Collection for a GUID | 20080723 |
| 9 | GET_RPM_DOCUMENT_BY_GUID |
Static method | Public | Method | Reads Reference from EDMS Collection for a GUID | 20080723 |
| 10 | GET_RPM_DOCUMENT_SINGLE |
Static method | Public | Method | Select single document with RPM GUID | 20080603 |
| 11 | GET_TEMPL_AREAS |
Static method | Public | Method | Reads the corresponding Template Areas for a given Portfolio | 20080929 |
Events
Class /RPM/CL_DOCUMENT_SERVICES has no event.
Types
Class /RPM/CL_DOCUMENT_SERVICES has no local type.
Method Signatures
Method DELETE_ALL_DOCS_IN_T_AREA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_ROOT_GUID | Call by reference | Type reference (TYPE) | /RPM/TV_GUID | Root Guid of the Document Template Area | 20081002 | ||
| 2 |  Returning |
RV_RC | Value transfer | Type reference (TYPE) | I | Return Value (0 = Call OK) | 20080929 |
Method DELETE_ALL_DOCS_IN_T_AREA on class /RPM/CL_DOCUMENT_SERVICES has no exception.
Method EDMS_APPL_PLUGIN_DO_INIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IP_AUTHORIZATION | Call by reference | Object reference (TYPE REF TO) | IF_ACO_AUTHORIZATION | Information About Authorization Subject | 20080929 | ||
| 2 | Importing |
IS_OBJECT | Call by reference | Type reference (TYPE) | EDMS_TS_LINKED_OBJECT | EDMS: Linked Object | 20080929 |
Method EDMS_APPL_PLUGIN_DO_INIT on class /RPM/CL_DOCUMENT_SERVICES has no exception.
Method EDMS_APPL_PLUGIN_GET_DOCUMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_OBJECT | Call by reference | Type reference (TYPE) | EDMS_TS_LINKED_OBJECT | EDMS: Linked Object | 20080929 | ||
| 2 | Importing |
IV_FORCE_READ | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20080929 | ||
| 3 | Returning |
RT_DOCUMENTS | Value transfer | Type reference (TYPE) | EDMS_TT_DOCUMENT_ID | EDMS: List of Documents | 20080929 |
Method EDMS_APPL_PLUGIN_GET_DOCUMENTS on class /RPM/CL_DOCUMENT_SERVICES has no exception.
Method GET_DOCUMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_COMMON | Call by reference | Object reference (TYPE REF TO) | OBJECT | Document Instance | 20080603 | ||
| 2 | Returning |
RR_DOCUMENTS | Value transfer | Object reference (TYPE REF TO) | OBJECT | Document Instance Collection | 20080603 |
Method GET_DOCUMENTS on class /RPM/CL_DOCUMENT_SERVICES has no exception.
Method GET_DOCUMENT_BY_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_DOCUMENTS | Call by reference | Object reference (TYPE REF TO) | OBJECT | Document Instance Collection | 20080603 | ||
| 2 | Importing |
IV_CHECK_FOLDER | Call by reference | Type reference (TYPE) | BOOLE_D | /RPM/CL_CO=>SC_TRUE | 'X': Folder vs. Document Check | 20080603 | |
| 3 | Importing |
IV_DOCUMENT_GUID | Value transfer | Type reference (TYPE) | DPR_TV_DOCUMENT_GUID | GUID for EDMS Document/Folder | 20080603 | ||
| 4 | Importing |
IV_FOLDER | Call by reference | Type reference (TYPE) | DPR_TV_IS_FOLDER | /RPM/CL_CO=>SC_FALSE | 'X': Folder; ' ': Document | 20080603 | |
| 5 | Returning |
RR_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | OBJECT | Document Instance | 20080603 |
Method GET_DOCUMENT_BY_GUID on class /RPM/CL_DOCUMENT_SERVICES has no exception.
Method GET_EDMS_DOCUMENT_SINGLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_EDMS_GUID | Call by reference | Type reference (TYPE) | /RPM/TV_GUID | Application Object GUID | 20080603 | ||
| 2 | Returning |
RS_DOCUMENT | Value transfer | Type reference (TYPE) | /RPM/TS_DOCUMENT | Documents | 20080603 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  NOT_FOUND |
Record not found | 20080603 |
Method GET_ENTITY_OF_DOC_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_ENTITY_GUID | Call by reference | Type reference (TYPE) | /RPM/TV_GUID | GUID of Project Element | 20080603 | ||
| 2 | Exporting |
EV_ENTITY_ID | Call by reference | Type reference (TYPE) | STRING | External ID of Project Element | 20080603 | ||
| 3 | Exporting |
EV_ENTITY_OTYPE | Call by reference | Type reference (TYPE) | /RPM/OBJECT_TYPE | Object Category of Project Element | 20080603 | ||
| 4 | Exporting |
EV_ENTITY_OTYPE_TEXT | Call by reference | Type reference (TYPE) | /RPM/OBJECT_TYPE_T | Object Category Text of Project Element | 20080603 | ||
| 5 | Importing |
IV_GUID | Call by reference | Type reference (TYPE) | /RPM/TV_GUID | EDMS or RPM GUID for Document | 20080603 |
Method GET_ENTITY_OF_DOC_DB on class /RPM/CL_DOCUMENT_SERVICES has no exception.
Method GET_PPM_DOCUMENT_BY_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_DOCUMENTS | Call by reference | Object reference (TYPE REF TO) | /RPM/CL_DOCUMENTS | PPM: Collection for Documents | 20080723 | ||
| 2 | Importing |
IV_CHECK_FOLDER | Call by reference | Type reference (TYPE) | BOOLE_D | /RPM/CL_CO=>SC_TRUE | 'X': Folder vs. Document Check | 20080723 | |
| 3 | Importing |
IV_DOCUMENT_GUID | Value transfer | Type reference (TYPE) | DPR_TV_DOCUMENT_GUID | GUID for EDMS Document/Folder | 20080723 | ||
| 4 | Importing |
IV_FOLDER | Call by reference | Type reference (TYPE) | DPR_TV_IS_FOLDER | /RPM/CL_CO=>SC_FALSE | 'X': Folder; ' ': Document | 20080723 | |
| 5 | Returning |
RR_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /RPM/CL_DOCUMENT | PPM: Document | 20080723 |
Method GET_PPM_DOCUMENT_BY_GUID on class /RPM/CL_DOCUMENT_SERVICES has no exception.
Method GET_RPM_DOCUMENT_BY_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_DOCUMENTS | Call by reference | Object reference (TYPE REF TO) | CL_RPM_DOCUMENTS | RPM: Collection for Documents | 20080723 | ||
| 2 | Importing |
IV_CHECK_FOLDER | Call by reference | Type reference (TYPE) | BOOLE_D | /RPM/CL_CO=>SC_TRUE | 'X': Folder vs. Document Check | 20080723 | |
| 3 | Importing |
IV_DOCUMENT_GUID | Value transfer | Type reference (TYPE) | DPR_TV_DOCUMENT_GUID | GUID for EDMS Document/Folder | 20080723 | ||
| 4 | Importing |
IV_FOLDER | Call by reference | Type reference (TYPE) | DPR_TV_IS_FOLDER | /RPM/CL_CO=>SC_FALSE | 'X': Folder; ' ': Document | 20080723 | |
| 5 | Returning |
RR_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | CL_RPM_DOCUMENT | RPM: Document | 20080723 |
Method GET_RPM_DOCUMENT_BY_GUID on class /RPM/CL_DOCUMENT_SERVICES has no exception.
Method GET_RPM_DOCUMENT_SINGLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_GUID | Call by reference | Type reference (TYPE) | /RPM/TV_GUID | Application Object GUID | 20080603 | ||
| 2 | Returning |
RS_DOCUMENT | Value transfer | Type reference (TYPE) | /RPM/TS_DOCUMENT | Documents | 20080603 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOT_FOUND |
Record not found | 20080603 |
Method GET_TEMPL_AREAS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | CGPL_OBJECT_TYPE | Object Type to which the Area does belong | 20080929 | ||
| 2 | Importing |
IV_PORTFOLIO_GUID | Call by reference | Type reference (TYPE) | /RPM/TV_GUID | Portfolio GUID | 20080929 | ||
| 3 | Exporting |
RT_DOC_T_AREAS | Call by reference | Type reference (TYPE) | /RPM/TT_DOC_T_AREA | GUIDs for the Document Template Area | 20080929 |
Method GET_TEMPL_AREAS on class /RPM/CL_DOCUMENT_SERVICES has no exception.
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 500_701 |
