SAP ABAP Class CL_PHIN_RECORD_MANAGEMENT (PHIN: functionality related to record management)
Hierarchy
☛
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
⤷
PM-EQM-THO (Application Component) Takeover/Handover of Technical Objects
⤷
PHIN (Package) Takeover/Handover of Technical Objects
⤷
⤷
Properties
| Class | CL_PHIN_RECORD_MANAGEMENT | |
| Short Description | PHIN: functionality related to record management | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | PHIN | Takeover/Handover of Technical Objects |
| Created | 20070104 | SAP |
| Last change | 20100310 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_PHIN_RECORD_MANAGEMENT has no interface implemented.
Friends
Class CL_PHIN_RECORD_MANAGEMENT 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 | 'PHIN_MAIN_APPL' | Application | 20070104 | ||
| 2 | Constant | Public | Type reference (TYPE) | BAPISPSID | 'SRM_SPS_DOCUMENT_PHIN' | Element Type ID | 20070104 | ||
| 3 | Constant | Public | Type reference (TYPE) | CHAR20 | 'AT_FINISH' | File description 'At Finish' | 20080731 | ||
| 4 | Constant | Public | Type reference (TYPE) | CHAR255 | 'LOG FINISH_HANDOVER' | File description 'LOG FINISH_HANDOVER' | 20080731 | ||
| 5 | Constant | Public | Type reference (TYPE) | STRING | 'HANDOVER' | Constant for 'Handover' | 20070604 | ||
| 6 | Constant | Private | Type reference (TYPE) | CHAR1 | 'H' | Constant for 'H' | 20070801 | ||
| 7 | Constant | Public | Type reference (TYPE) | BAPIDOCID | 'PHIN Record Model' | Document ID | 20070104 | ||
| 8 | Constant | Public | Type reference (TYPE) | BAPISPSID | 'PHIN_SPS_RECORD_MODEL' | Element Type ID | 20070104 | ||
| 9 | Constant | Public | Type reference (TYPE) | BAPISPSID | 'PHIN_SPS_RECORD' | Element Type ID | 20070104 | ||
| 10 | Constant | Public | Type reference (TYPE) | BAPIRMSID | 'S_RMS_PHIN' | RMS ID in SRM | 20070104 | ||
| 11 | Constant | Public | Type reference (TYPE) | STRING | 'TAKEOVER' | Constant for 'Takeover' | 20070604 | ||
| 12 | Constant | Private | Type reference (TYPE) | CHAR1 | 'T' | Constant for 'T' | 20070801 | ||
| 13 | Constant | Public | Type reference (TYPE) | BAPISPSID | 'SRM_SPS_GENERAL_URL_PHIN' | Element Type ID | 20070104 | ||
| 14 | Constant | Public | Type reference (TYPE) | CATSDTXT | 'Web Dynpro' | Document ID | 20070104 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Private | Method | Add Document Instance to Record | 20070821 | |
| 2 | Static method | Private | Method | Add Message | 20070801 | |
| 3 | Static method | Private | Method | Construct URL Link | 20070104 | |
| 4 | Static method | Private | Method | Convert plain text into HTML format | 20080515 | |
| 5 | Static method | Public | Method | add a Text Document to an existing Record | 20080731 | |
| 6 | Static method | Private | Method | Create Document Instance for XML file | 20070104 | |
| 7 | Static method | Public | Method | Create Record Instance | 20070104 | |
| 8 | Static method | Private | Method | Create URL Instance | 20070104 | |
| 9 | Static method | Private | Method | Find URL Instance | 20070104 | |
| 10 | Static method | Private | Method | Get Name of WD Application | 20070104 |
Events
Class CL_PHIN_RECORD_MANAGEMENT has no event.
Types
Class CL_PHIN_RECORD_MANAGEMENT has no local type.
Method Signatures
Method ADD_DOCUMENT_TO_RECORD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20070821 | |||
| 2 | IV_DESCR | Call by reference | Type reference (TYPE) | CHAR255 | Char255 | 20070821 | |||
| 3 | IV_DOCUMENTCLASS | Call by reference | Type reference (TYPE) | BAPIDCLASS | Storage Location of Document in SRM (Content Model) | 20070821 | |||
| 4 | IV_DOC_ID | Call by reference | Type reference (TYPE) | STRING | Document ID | 20070821 | |||
| 5 | IV_OBJECTID | Call by reference | Type reference (TYPE) | BAPIGUID | GUID | 20070821 |
Method ADD_DOCUMENT_TO_RECORD on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method ADD_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_MSG | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070801 | |||
| 2 | IV_PHIN_GUID | Call by reference | Type reference (TYPE) | PHIN_D_PHINGUID | Generic Key for Takeover/Handover | 20070801 |
Method ADD_MESSAGE on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method CONSTRUCT_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_APPLICATION | Call by reference | Type reference (TYPE) | STRING | 20070104 | ||||
| 2 | IV_FILENAME | Call by reference | Type reference (TYPE) | PHIN_D_FILE | Phase In: File Name | 20070110 | |||
| 3 | RV_URL | Value transfer | Type reference (TYPE) | STRING | 20070104 |
Method CONSTRUCT_URL on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method CONVERT_LOG_TO_HTML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_HTML_TEXT | Call by reference | Type reference (TYPE) | SRM_BSP_ASC_TAB | Text in HTML format | 20080515 | |||
| 2 | IT_PLAIN_TEXT | Call by reference | Type reference (TYPE) | DMS_TAB_TDLINE | Table of TDLINE Entries for BAdI Calls | 20080515 |
Method CONVERT_LOG_TO_HTML on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method CREATE_AND_ADD_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_PHINH | Call by reference | Type reference (TYPE) | PHINH | Header Table for Take Over | 20080731 | |||
| 2 | IT_TEXTS | Call by reference | Type reference (TYPE) | DMS_TAB_TDLINE | Return Parameter | 20080731 | |||
| 3 | IV_DOCUMENTCLASS | Call by reference | Type reference (TYPE) | BAPIDCLASS | Storage Location of Document in SRM (Content Model) | 20080731 | |||
| 4 | IV_DOC_DESCRIPTION | Call by reference | Type reference (TYPE) | CHAR20 | Prefix of File Name | 20080731 | |||
| 5 | IV_DOC_ID_DESCRIPTION | Call by reference | Type reference (TYPE) | CHAR255 | Description of File | 20080731 | |||
| 6 | IV_OBJECTID | Call by reference | Type reference (TYPE) | BAPIGUID | GUID | 20080731 |
Method CREATE_AND_ADD_DOCUMENT on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method CREATE_DOCUMENT_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_DOC_ID | Call by reference | Type reference (TYPE) | STRING | 20070104 | ||||
| 2 | IT_PLAIN_TEXT | Call by reference | Type reference (TYPE) | DMS_TAB_TDLINE | Table of TDLINE Entries for BAdI Calls | 20070601 | |||
| 3 | IV_DOCOMMIT | Call by reference | Type reference (TYPE) | BAPIGSBOOL | Boolean | 20070605 | |||
| 4 | IV_DOCUMENTID | Call by reference | Type reference (TYPE) | BAPIDOCID | Document ID | 20070604 | |||
| 5 | IV_STORE_TEXT_AS_HTML | Call by reference | Type reference (TYPE) | BAPIGSBOOL | ABAP_FALSE | Boolean | 20080515 | ||
| 6 | IV_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | Business Document Service: File Content ASCII | 20070104 |
Method CREATE_DOCUMENT_INSTANCE on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method CREATE_RECORD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MSG | Call by reference | Type reference (TYPE) | BAPIRETTAB | Return Parameter | 20070104 | |||
| 2 | EV_DOCUMENTCLASS | Call by reference | Type reference (TYPE) | BAPIDCLASS | Storage Location of Document in SRM (Content Model) | 20070104 | |||
| 3 | EV_OBJECTID | Call by reference | Type reference (TYPE) | BAPIGUID | GUID | 20070104 | |||
| 4 | IT_PLAIN_TEXT | Call by reference | Type reference (TYPE) | DMS_TAB_TDLINE | For the messages | 20070529 | |||
| 5 | IV_DOCOMMIT | Call by reference | Type reference (TYPE) | BAPIGSBOOL | Boolean | 20070605 | |||
| 6 | IV_FILENAME | Call by reference | Type reference (TYPE) | PHIN_D_FILE | Phase In: File Name | 20070104 | |||
| 7 | IV_PHINTYPE | Call by reference | Type reference (TYPE) | PHIN_D_PHINTYPE | Header Table for Take Over | 20070104 | |||
| 8 | IV_PHIN_GUID | Call by reference | Type reference (TYPE) | PHIN_D_PHINGUID | Generic Key for Take Over/ Hand Over | 20070104 | |||
| 9 | IV_PLAIN_TITLE | Call by reference | Type reference (TYPE) | STRING | Title for Plain Text | 20070822 | |||
| 10 | IV_STORE_TEXT_AS_HTML | Call by reference | Type reference (TYPE) | BAPIGSBOOL | ABAP_FALSE | Boolean | 20080515 | ||
| 11 | IV_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | Business Document Service: File Content ASCII | 20070104 |
Method CREATE_RECORD on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method CREATE_URL_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TEXT | Call by reference | Type reference (TYPE) | STRING | Description | 20070104 | |||
| 2 | IV_URL | Call by reference | Type reference (TYPE) | STRING | Long Text | 20070104 | |||
| 3 | RV_GUID | Value transfer | Type reference (TYPE) | BAPIGUID | GUID | 20070104 |
Method CREATE_URL_INSTANCE on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method FIND_URL_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TEXT | Call by reference | Type reference (TYPE) | STRING | Description | 20070104 | |||
| 2 | IV_URL | Call by reference | Type reference (TYPE) | STRING | Long Text | 20070104 | |||
| 3 | RV_GUID | Value transfer | Type reference (TYPE) | BAPIGUID | GUID | 20070104 |
Method FIND_URL_INSTANCE on class CL_PHIN_RECORD_MANAGEMENT has no exception.
Method GET_APPL_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_APPL_NAME | Value transfer | Type reference (TYPE) | STRING | 20070104 | ||||
| 2 | IR_COMP_API | Call by reference | Object reference (TYPE REF TO) | IF_WD_COMPONENT | Web Dynpro: Component | 20070104 |
Method GET_APPL_NAME on class CL_PHIN_RECORD_MANAGEMENT has no exception.
History
| Last changed by/on | SAP | 20100310 |
| SAP Release Created in | 700 |