SAP ABAP Class CL_TFW_COMMENT (Object Commenting implementation)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-TFW (Application Component) Tagging Framework
⤷
STFW_CORE (Package) Tagging Framework Core
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_TFW_OBJECT_MAINT | Central Object Maintenance | 20130416 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_TFW_COMMENT | Comment Interface | 20130412 |
Properties
| Class | CL_TFW_COMMENT | |
| Short Description | Object Commenting implementation | |
| Super Class | CL_TFW_OBJECT_MAINT | Central Object Maintenance |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | STFW_CORE | Tagging Framework Core |
| Created | 20130412 | 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... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_TFW_COMMENT | Comment Interface | 20130412 |
Friends
Class CL_TFW_COMMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | SEQG3-GNAME | 'TFW_OBJECT_CMNT' | Elementary Lock of Lock Entry (Table Name) | 20130517 | ||
| 2 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_TFW_COMMENT_DB | Comment DB Interface | 20130418 | |||
| 3 | Instance attribute | Private | Type reference (TYPE) | S_BUFFER | Buffer for DB | 20130416 | |||
| 4 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | Flag for DB Reset | 20130515 | |||
| 5 | Instance attribute | Private | Type reference (TYPE) | TFW_TMSTMP | Creation Timestamp | 20130514 | |||
| 6 | Instance attribute | Private | Type reference (TYPE) | TFW_UNAM | Comment Author | 20130417 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | Constructor | 20130416 | |
| 2 | Static method | Public | Method | Create Unique ID for Comment Thread | 20130417 | |
| 3 | Instance method | Private | Method | Delete Hierarchy of Comments based on Parent Thread | 20130417 | |
| 4 | Instance method | Private | Method | Update buffer from DB data | 20130416 | |
| 5 | Instance method | Private | Method | Save the Buffer to the DB | 20130416 | |
| 6 | Instance method | Private | Method | Set the Temporary Buffer | 20130416 |
Events
Class CL_TFW_COMMENT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_BUFFER | Private | See coding | comments Buffer | 20130416 | BEGIN OF s_buffer,
comment_tab TYPE ts_comment_buffer,
END OF s_buffer
|
|
| 2 | S_COMMENT_BUFFER | Private | See coding | Structure for Comment DB Buffer | 20130416 | BEGIN OF s_comment_buffer,
seqnr TYPE n LENGTH 6.
INCLUDE TYPE if_tfw_comment=>s_comment.
TYPES: delete TYPE abap_bool,
END OF s_comment_buffer
|
|
| 3 | TS_COMMENT_BUFFER | Private | See coding | Table for Comment DB Buffer | 20130416 | ts_comment_buffer TYPE SORTED TABLE OF s_comment_buffer
WITH UNIQUE KEY seqnr
|
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_KEY_VALUE | Call by reference | Type reference (TYPE) | IF_TFW_TYPES=>TS_OBJ_KEY_VAL | Table Type for Object Key-Value pair | 20130416 | |||
| 2 | IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | IF_TFW_TYPES=>OBJECT_TYPE_ID | TFW: Object Type Identifier | 20130416 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | TFW: Runtime Exception Class | 20130613 |
Method CREATE_THREAD_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_ID | Value transfer | Type reference (TYPE) | TFW_THREAD_ID | TFW: Comment Thread ID | 20130417 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | TFW: Runtime Exception Class | 20130419 |
Method DELETE_COMMENT_HIERARCHY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CTS_COMMENT_TABLE | Call by reference | Type reference (TYPE) | TS_COMMENT_BUFFER | 20130417 | ||||
| 2 | IV_PARENT | Call by reference | Type reference (TYPE) | TFW_THREAD_ID | TFW: Comment Thread ID | 20130417 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | TFW: Runtime Exception Class | 20130613 |
Method LOAD_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_BUFFER | Value transfer | Type reference (TYPE) | S_BUFFER | 20130416 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | TFW: Runtime Exception Class | 20130613 |
Method SAVE_BUFFER_DB Signature
Method SAVE_BUFFER_DB on class CL_TFW_COMMENT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | TFW: Runtime Exception Class | 20130613 |
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 | 20130417 |
Method SET_BUFFER on class CL_TFW_COMMENT has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |