SAP ABAP Interface IF_TFW_COMMENT (Comment Interface)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-TFW (Application Component) Tagging Framework
⤷
STFW_CORE (Package) Tagging Framework Core
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-TFW (Application Component) Tagging Framework⤷
STFW_CORE (Package) Tagging Framework Core
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_TFW_COMMENT | Object Commenting implementation | 20130412 |
Properties
| Interface | IF_TFW_COMMENT | |
| Short Description | Comment Interface |
General Data
| Package | STFW_CORE | Tagging Framework Core |
| Created | 20130412 | SAP |
| Last changed | 20140121 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | IF_TFW_COMMENT | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | IF_TFW_TYPES | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_TFW_METADATA | Metadata Interface | 20130412 |
Friends
Interface IF_TFW_COMMENT has no friend.
Attributes
Interface IF_TFW_COMMENT has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_COMMENT |
Instance method | Public | Method | Add a comment to an object | 20130417 |
| 2 | DELETE_COMMENT |
Instance method | Public | Method | Delete a comment for an object | 20130417 |
| 3 | GET_COMMENTS |
Instance method | Public | Method | Get Comments for an object | 20130412 |
| 4 | UPDATE_COMMENT |
Instance method | Public | Method | Update a comment for an object | 20130417 |
Events
Interface IF_TFW_COMMENT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_COMMENT | Public | See coding | Structure for Comment | 20130412 | BEGIN OF s_comment,
comment_txt TYPE tfw_cmnt_txt,
thread_id TYPE tfw_thread_id,
thread_ref_id TYPE tfw_thread_id,
created_by TYPE tfw_unam,
created_on TYPE tfw_tmstmp,
END OF s_comment
|
|
| 2 | S_COMMENT_DB | Public | See coding | Structure for Comment DB | 20130418 | BEGIN OF s_comment_db,
object_id TYPE if_tfw_types=>object_id,
object_type_id TYPE if_tfw_types=>object_type_id,
seqnr TYPE n LENGTH 6,
simplekey TYPE abap_bool.
INCLUDE TYPE s_comment.
TYPES: delete TYPE abap_bool.
TYPES: END OF s_comment_db
|
|
| 3 | TS_COMMENT | Public | See coding | Table for Comment | 20130412 | ts_comment TYPE SORTED TABLE OF s_comment
WITH UNIQUE KEY thread_id
|
|
| 4 | TS_COMMENT_DB | Public | See coding | Table for Comment DB | 20130418 | ts_comment_db TYPE SORTED TABLE OF s_comment_db
WITH UNIQUE KEY object_id object_type_id seqnr
|
Method Signatures
Method ADD_COMMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IS_COMMENT | Call by reference | Type reference (TYPE) | IF_TFW_COMMENT=>S_COMMENT | Table of Comment | 20130417 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_TFW_RUNTIME_ERROR |
TFW: Runtime Exception Class | 20130614 |
Method DELETE_COMMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_COMMENT | Call by reference | Type reference (TYPE) | IF_TFW_COMMENT=>S_COMMENT | Table of Comment | 20130417 | ||
| 2 | Importing |
IV_DELETE_ALL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 'X': Delete All Comments | 20130417 | |
| 3 | Importing |
IV_DELETE_FOR_USER | Call by reference | Type reference (TYPE) | TFW_UNAM | TFW: Tag Author | 20130417 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_TFW_RUNTIME_ERROR |
TFW: Runtime Exception Class | 20130614 |
Method GET_COMMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RTS_COMMENT | Value transfer | Type reference (TYPE) | IF_TFW_COMMENT=>TS_COMMENT | Table of Comment | 20130412 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_TFW_RUNTIME_ERROR |
TFW: Runtime Exception Class | 20130614 |
Method UPDATE_COMMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_COMMENT | Call by reference | Type reference (TYPE) | IF_TFW_COMMENT=>S_COMMENT | Table of Comment | 20130417 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_TFW_RUNTIME_ERROR |
TFW: Runtime Exception Class | 20130614 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |
