SAP ABAP Class CL_FDT_ACTN_EMAIL (FDT: Email (Action))
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
⤷
SFDT_EXPRESSIONS (Package) BRFplus: Expressions
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_FDT_ACTION | FDT: Abstract Action Class | 20080819 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_FDT_ACTN_EMAIL | FDT: Email (Action) | 20080819 |
Properties
| Class | CL_FDT_ACTN_EMAIL | |
| Short Description | FDT: Email (Action) | |
| Super Class | CL_FDT_ACTION | FDT: Abstract Action Class |
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SFDT_EXPRESSIONS | BRFplus: Expressions |
| Created | 20080819 | SAP |
| Last change | 20140121 | 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 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 3 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_FDT_ACTN_EMAIL | FDT: Email (Action) | 20080819 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_FDT_FACTORY | 20080819 | FDT: Factory |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | Type reference (TYPE) | TABNAME | 'FDT_ACTN_6000' | Table Name | 20080822 | ||
| 2 | Instance attribute | Private | Type reference (TYPE) | S_BUFFER | 20080822 | ||||
| 3 | Instance attribute | Private | Type reference (TYPE) | S_BUFFER | 20080822 | ||||
| 4 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE: MS_BUFFER_DB is loaded | 20080822 | |||
| 5 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE: MS_BUFFER is loaded | 20080822 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Add the value(data) to the recipients list | 20130816 | |
| 2 | Instance method | Private | Method | Check body and Subject of the message | 20100129 | |
| 3 | Instance method | Private | Method | Check the list of recipients | 20080825 | |
| 4 | Instance method | Private | Method | Generate process code for email action | 20090209 | |
| 5 | Instance method | Private | Method | Generate process code for long texts in email body or sub. | 20091201 | |
| 6 | Instance method | Private | Method | Generate the code for result data object | 20090209 | |
| 7 | Static method | Public | Method | Get the string representation of the value(data) | 20081208 | |
| 8 | Static method | Public | Method | Get the tokens from the Subject or Body string of the email | 20090102 | |
| 9 | Instance method | Private | Method | 20080819 | ||
| 10 | Instance method | Private | Method | 20080819 | ||
| 11 | Instance method | Private | Method | 20080819 | ||
| 12 | Instance method | Private | Method | 20080819 | ||
| 13 | Instance method | Private | Method | Split the long text into length of 50 for trace parameter | 20110512 |
Events
Class CL_FDT_ACTN_EMAIL has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_BUFFER | Private | See coding | 20080819 | BEGIN OF s_buffer,
t_recipient TYPE if_fdt_actn_email=>t_recipient,
subject TYPE if_fdt_actn_email=>subject,
body TYPE if_fdt_actn_email=>body,
ts_message_parameter TYPE if_fdt_actn_email=>ts_parameter,
ts_rec_parameter TYPE if_fdt_actn_email=>ts_parameter,
END OF s_buffer
|
||
| 2 | S_TOKEN | Public | See coding | 20090102 | BEGIN OF s_token,
position TYPE i,
token TYPE string,
type TYPE fdt_email_token_type,
END OF s_token
|
||
| 3 | TS_TOKEN | Public | See coding | 20090102 | ts_token TYPE SORTED TABLE OF s_token WITH UNIQUE KEY position
|
Method Signatures
Method ADD_RECIPIENTS_FROM_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IA_DATA | Call by reference | Type reference (TYPE) | ANY | Data to be converted to string | 20130816 | |||
| 2 | IO_MSG_OBJ | Call by reference | Object reference (TYPE REF TO) | CL_BCS_MESSAGE | BCS: Send Message | 20130816 |
Method ADD_RECIPIENTS_FROM_DATA on class CL_FDT_ACTN_EMAIL has no exception.
Method CHECK_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ITS_MSG_PARAM | Call by reference | Type reference (TYPE) | IF_FDT_ACTN_EMAIL=>TS_PARAMETER | 20100129 | ||||
| 2 | ITS_REC_PARAM | Call by reference | Type reference (TYPE) | IF_FDT_ACTN_EMAIL=>TS_PARAMETER | 20100129 | ||||
| 3 | IV_ACTIVATION_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20100129 | |||
| 4 | IV_BODY | Call by reference | Type reference (TYPE) | IF_FDT_ACTN_EMAIL=>BODY | Email Body | 20100129 | |||
| 5 | IV_SUBJECT | Call by reference | Type reference (TYPE) | IF_FDT_ACTN_EMAIL=>SUBJECT | Subject of the email | 20100129 | |||
| 6 | RT_MESSAGE | Value transfer | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20100129 |
Method CHECK_PARAMETERS on class CL_FDT_ACTN_EMAIL has no exception.
Method CHECK_RECIPIENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ITS_PARAMETER | Call by reference | Type reference (TYPE) | IF_FDT_ACTN_EMAIL=>TS_PARAMETER | 20091201 | ||||
| 2 | IT_RECIPIENT | Call by reference | Type reference (TYPE) | IF_FDT_ACTN_EMAIL=>T_RECIPIENT | List of Email Recipients | 20080825 | |||
| 3 | IV_ACTIVATION_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20090102 | |||
| 4 | IV_RECIPIENT | Call by reference | Type reference (TYPE) | IF_FDT_ACTN_EMAIL=>RECIPIENT | Email Recipient | 20100317 | |||
| 5 | RT_MESSAGE | Value transfer | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20080825 |
Method CHECK_RECIPIENTS on class CL_FDT_ACTN_EMAIL has no exception.
Method GENERATE_EMAIL_PROCESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CTS_USED_CONTEXT_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_USED_CONTEXT_ID | 20090209 | ||||
| 2 | ET_SOURCE_CODE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_SOURCE_CODE | 20090209 | ||||
| 3 | IO_GENERATION_MNGR | Call by reference | Object reference (TYPE REF TO) | CL_FDT_GENERATION_MANAGER | FDT: Generation of Classes | 20090209 | |||
| 4 | IV_CREATE_VARIABLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20090209 | |||
| 5 | IV_FUNCTION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | 20090209 | ||||
| 6 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | 20090209 | ||||
| 7 | IV_VARIABLE_NAME | Call by reference | Type reference (TYPE) | CLIKE | 20090209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20121029 |
Method GENERATE_LONG_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_SOURCE_CODE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_SOURCE_CODE | Table with Source Code | 20091201 | |||
| 2 | IO_GENERATION_MNGR | Call by reference | Object reference (TYPE REF TO) | CL_FDT_GENERATION_MANAGER | FDT: Generation of Classes | 20091201 | |||
| 3 | IV_LONG_TEXT | Call by reference | Type reference (TYPE) | STRING | 20091201 | ||||
| 4 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | Time Stamp (active version) | 20091201 | |||
| 5 | IV_VARIABLE_NAME | Call by reference | Type reference (TYPE) | CLIKE | 20091201 |
Method GENERATE_LONG_STRING on class CL_FDT_ACTN_EMAIL has no exception.
Method GENERATE_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CTS_USED_CONTEXT_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TS_USED_CONTEXT_ID | Actually used / required ID's from context in generated code | 20090209 | |||
| 2 | ET_SOURCE_CODE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_SOURCE_CODE | Table with Source Code | 20090209 | |||
| 3 | IO_GENERATION_MNGR | Call by reference | Object reference (TYPE REF TO) | CL_FDT_GENERATION_MANAGER | FDT: Generation of Classes | 20090209 | |||
| 4 | IV_CREATE_VARIABLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090209 | ||||
| 5 | IV_FUNCTION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | Universal Unique Identifier | 20090209 | |||
| 6 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20090209 | |||
| 7 | IV_VARIABLE_NAME | Call by reference | Type reference (TYPE) | CLIKE | 20090209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Error in the Generation Process | 20090324 |
Method GET_STRING_FROM_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IA_DATA | Call by reference | Type reference (TYPE) | ANY | Data to be converted to string | 20081208 | |||
| 2 | RV_STRING | Value transfer | Type reference (TYPE) | STRING | String representation of the data passed | 20081208 |
Method GET_STRING_FROM_DATA on class CL_FDT_ACTN_EMAIL has no exception.
Method GET_TOKEN_FROM_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_STRING_DATA | Call by reference | Type reference (TYPE) | STRING | 20090102 | ||||
| 2 | RTS_TOKEN | Value transfer | Type reference (TYPE) | TS_TOKEN | 20090102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20090102 |
Method LOAD_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TIMESTAMP | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>TIMESTAMP | 20080819 | ||||
| 2 | IV_VERSION | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>VERSION | 20080819 | ||||
| 3 | RS_BUFFER | Value transfer | Type reference (TYPE) | S_BUFFER | 20080819 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20080819 |
Method LOAD_BUFFER_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_VERSION | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>VERSION | 20080819 | ||||
| 2 | RS_BUFFER | Value transfer | Type reference (TYPE) | S_BUFFER | 20080819 |
Method LOAD_BUFFER_DB on class CL_FDT_ACTN_EMAIL has no exception.
Method SAVE_BUFFER_DB Signature
Method SAVE_BUFFER_DB on class CL_FDT_ACTN_EMAIL has no parameter.
Method SAVE_BUFFER_DB on class CL_FDT_ACTN_EMAIL has no exception.
Method SET_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_BUFFER | Call by reference | Type reference (TYPE) | S_BUFFER | 20080819 |
Method SET_BUFFER on class CL_FDT_ACTN_EMAIL has no exception.
Method SPLIT_RECIPIENT_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_MSG_1 | Call by reference | Type reference (TYPE) | STRING | 20110512 | ||||
| 2 | EV_MSG_2 | Call by reference | Type reference (TYPE) | STRING | 20110512 | ||||
| 3 | EV_MSG_3 | Call by reference | Type reference (TYPE) | STRING | 20110512 | ||||
| 4 | EV_MSG_4 | Call by reference | Type reference (TYPE) | STRING | 20110512 | ||||
| 5 | IV_STRING | Call by reference | Type reference (TYPE) | STRING | 20110512 |
Method SPLIT_RECIPIENT_STRING on class CL_FDT_ACTN_EMAIL has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 712 |