SAP ABAP Class CL_CFX_P_NOTIFICATION_TEMPLATE (Persistence of the Notification Templates)
Hierarchy
☛
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
⤷
PLM-CFO (Application Component) Collaboration Folders
⤷
CFX_NOTIFICATION (Package) Manages Notifications
⤷
⤷
Properties
| Class | CL_CFX_P_NOTIFICATION_TEMPLATE | |
| Short Description | Persistence of the Notification Templates | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CFX_NOTIFICATION | Manages Notifications |
| Created | 20060116 | SAP |
| Last change | 20141109 | |
| 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) |
Interfaces
Class CL_CFX_P_NOTIFICATION_TEMPLATE has no interface implemented.
Friends
Class CL_CFX_P_NOTIFICATION_TEMPLATE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_CFX_P_NOTIFICATION_TEMPLATE | Persistence of the Notification Templates | 20060116 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Checks Whether There is already a Template with Given Name | 20060420 | |
| 2 | Static method | Public | Method | Storage of the Changes in the Persistence Layer | 20060116 | |
| 3 | Instance method | Public | Method | Decrements the USED field by 1 | 20060419 | |
| 4 | Instance method | Public | Method | Deletion of a Notification Template | 20060116 | |
| 5 | Static method | Public | Method | Retrieving the Instance | 20060116 | |
| 6 | Instance method | Public | Method | Gets the name for given Id | 20060519 | |
| 7 | Instance method | Public | Method | Get All Attributes of a Notification Template | 20060119 | |
| 8 | Instance method | Public | Method | Gets the USED field which gives the times template is used | 20060419 | |
| 9 | Instance method | Public | Method | Gets the 'Used For' field | 20070226 | |
| 10 | Instance method | Public | Method | Increments the USED field by 1 | 20060419 | |
| 11 | Instance method | Public | Method | Add a Notification Template | 20060116 | |
| 12 | Instance method | Public | Method | Checks Whether The Usage Of A Template Is Restricted | 20060522 | |
| 13 | Instance method | Public | Method | Checks Whether A Template Is Being Used | 20060629 | |
| 14 | Instance method | Public | Method | Releases The Template For Usage By All Applications | 20060522 | |
| 15 | Instance method | Public | Method | Restricts Template for Specific Use | 20060522 | |
| 16 | Instance method | Public | Method | Search Notification Templates By Certain Criteria | 20060116 | |
| 17 | Instance method | Public | Method | Update a Notification Template | 20060313 |
Events
Class CL_CFX_P_NOTIFICATION_TEMPLATE has no event.
Types
Class CL_CFX_P_NOTIFICATION_TEMPLATE has no local type.
Method Signatures
Method CHECK_DUPLICATE_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NAME | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_NAME | Name field for Notification Templates | 20060420 | |||
| 2 | R_EXISTS | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20060420 |
Method CHECK_DUPLICATE_NAME on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method COMMIT Signature
Method COMMIT on class CL_CFX_P_NOTIFICATION_TEMPLATE has no parameter.
Method COMMIT on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method DECREMENT_USED_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20060419 |
Method DECREMENT_USED_COUNT on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method DELETE_NTF_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | Collaboration Folder: ID of a Notification Template | 20060116 |
Method DELETE_NTF_TEMPLATE on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_P_NTF_TEMPLATE | Value transfer | Object reference (TYPE REF TO) | CL_CFX_P_NOTIFICATION_TEMPLATE | Persistence of the Notification Templates | 20060116 |
Method GET_INSTANCE on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method GET_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ID | Call by reference | Type reference (TYPE) | STRING | 20060519 | ||||
| 2 | R_NAME | Value transfer | Type reference (TYPE) | STRING | 20060519 |
Method GET_NAME on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method GET_NTF_TEMPLATE_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_NTF_TEMPLATE_ATTRIBUTES | Value transfer | Type reference (TYPE) | CFX_NTF_TEMPLATE | Collaboration Folders: Notification templates | 20060119 | |||
| 2 | I_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | Collaboration Folder: ID of a Notification Template | 20060119 |
Method GET_NTF_TEMPLATE_ATTRIBUTES on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method GET_USED_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20060419 | |||
| 2 | R_USED | Value transfer | Type reference (TYPE) | INT4 | Natural number | 20060419 |
Method GET_USED_COUNT on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method GET_USED_FOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20070226 | |||
| 2 | R_USED_FOR | Value transfer | Type reference (TYPE) | STRING | 20070226 |
Method GET_USED_FOR on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method INCREMENT_USED_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20060419 |
Method INCREMENT_USED_COUNT on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method INSERT_NTF_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_CREATED_BY | Call by reference | Type reference (TYPE) | CFX_CREATED_BY | Created By | 20060116 | |||
| 2 | E_CREATED_ON | Call by reference | Type reference (TYPE) | CFX_CREATED_ON | Created on | 20060116 | |||
| 3 | I_NAME | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_NAME | Name of a Notification Template | 20060116 | |||
| 4 | I_NOTE | Call by reference | Type reference (TYPE) | CFX_COMMENT | Sender of a Notification Template | 20060116 | |||
| 5 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | Collaboration Folder: ID of a Notification Template | 20060116 | |||
| 6 | I_PRIORITY | Call by reference | Type reference (TYPE) | CFX_PRIORITY | Priority of a Notification Template | 20060116 | |||
| 7 | I_SUBJECT | Call by reference | Type reference (TYPE) | CFX_SUBJECT | Subject of a Notification Template | 20060116 |
Method INSERT_NTF_TEMPLATE on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method IS_RESTRICTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20060522 | |||
| 2 | R_RESTRICTED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20060522 |
Method IS_RESTRICTED on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method IS_USED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20060629 | |||
| 2 | R_USED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20060629 |
Method IS_USED on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method RELEASE_USE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20060522 |
Method RELEASE_USE on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method RESTRICT_USE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20060522 | |||
| 2 | I_OPTION | Call by reference | Type reference (TYPE) | STRING | 20060522 |
Method RESTRICT_USE on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method SELECT_NTF_TEMPLATES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_NTF_ID | Call by reference | Type reference (TYPE) | CFX_TT_NTF_TMPL_ID | List with Notification Template IDs | 20060116 | |||
| 2 | ET_NTF_TEMPLATES | Call by reference | Type reference (TYPE) | CFX_TT_NTF_TMPL | List with Notification Templates | 20060117 | |||
| 3 | I_CHANGED_BY | Value transfer | Type reference (TYPE) | CFX_CHANGED_BY | Changed by | 20060116 | |||
| 4 | I_CHANGED_ON | Value transfer | Type reference (TYPE) | CFX_CHANGED_ON | Changed on | 20060116 | |||
| 5 | I_CREATED_BY | Value transfer | Type reference (TYPE) | CFX_CREATED_BY | Created By | 20060116 | |||
| 6 | I_CREATED_ON | Value transfer | Type reference (TYPE) | CFX_CREATED_ON | Created By | 20060116 | |||
| 7 | I_GET_DATA | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Get Notification Template Data Immediately | 20060116 | ||
| 8 | I_PRIORITY | Value transfer | Type reference (TYPE) | CFX_PRIORITY | Priority of a Notification | 20060116 | |||
| 9 | I_TEXT_IN_COMMENT | Value transfer | Type reference (TYPE) | STRING | Text in Commentary | 20060116 | |||
| 10 | I_TEXT_IN_SUBJECT | Value transfer | Type reference (TYPE) | STRING | Text in Subject | 20060116 | |||
| 11 | I_USED_FOR | Call by reference | Type reference (TYPE) | STRING | 20060522 |
Method SELECT_NTF_TEMPLATES on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
Method UPDATE_NTF_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_CHANGED_BY | Call by reference | Type reference (TYPE) | CFX_CHANGED_BY | Created By | 20060313 | |||
| 2 | E_CHANGED_ON | Call by reference | Type reference (TYPE) | CFX_CHANGED_ON | Created on | 20060313 | |||
| 3 | I_NAME | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_NAME | Name field for Notification Templates | 20060313 | |||
| 4 | I_NOTE | Call by reference | Type reference (TYPE) | CFX_COMMENT | Commentary Text for Notifications | 20060313 | |||
| 5 | I_NTF_TMPL_ID | Call by reference | Type reference (TYPE) | CFX_NTF_TMPL_ID | ID for Notification Templates | 20060313 | |||
| 6 | I_PRIORITY | Call by reference | Type reference (TYPE) | CFX_PRIORITY | Priority of a Notification | 20060313 | |||
| 7 | I_SUBJECT | Call by reference | Type reference (TYPE) | CFX_SUBJECT | Subject of a Notification | 20060313 |
Method UPDATE_NTF_TEMPLATE on class CL_CFX_P_NOTIFICATION_TEMPLATE has no exception.
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 450 |