SAP ABAP Class CL_SATC_AC_TEXT_HANDLE_COMMON (Text handle: Code locations and common text repositories)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-DWB-TOO-ATF (Application Component) ABAP Test Frameworks ( ATC, CheckMan, Code Inspector)
⤷
SATC_ABAP_CHECK_SVC_API (Package) INTERNAL: - *NO* REUSE - Test services API
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SATC_AC_TEXT_HANDLE | Text handle: Abstract base class | 20130523 |
Properties
| Class | CL_SATC_AC_TEXT_HANDLE_COMMON | |
| Short Description | Text handle: Code locations and common text repositories | |
| Super Class | CL_SATC_AC_TEXT_HANDLE | Text handle: Abstract base class |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SATC_ABAP_CHECK_SVC_API | INTERNAL: - *NO* REUSE - Test services API |
| Created | 20081016 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_SATC_AC_TEXT_HANDLE_COMMON has no forward declaration.
Interfaces
Class CL_SATC_AC_TEXT_HANDLE_COMMON has no interface implemented.
Friends
Class CL_SATC_AC_TEXT_HANDLE_COMMON has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | See coding | 20130523 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add location in include | 20130523 | |
| 2 | Instance method | Public | Method | Add location in include, describe by text element | 20130523 | |
| 3 | Instance method | Public | Method | Add location in include, describe by t100 message | 20130523 | |
| 4 | Instance method | Public | Method | Add location in method | 20130523 | |
| 5 | Instance method | Public | Method | Add location im method, describe by text element | 20130523 | |
| 6 | Instance method | Public | Method | Add location in method, describe by t100 message | 20130523 | |
| 7 | Instance method | Public | Method | Add plain text (no translation) | 20130523 | |
| 8 | Instance method | Public | Method | Add plain texts (no translation) | 20130523 | |
| 9 | Instance method | Public | Method | Add T100 message | 20130523 | |
| 10 | Instance method | Public | Method | Add T100 messages | 20130523 | |
| 11 | Instance method | Public | Method | Add text element of program (limited translation) | 20130523 | |
| 12 | Instance method | Public | Method | Add text elements of program (limited translation) | 20130523 | |
| 13 | Instance method | Public | Method | Reset text content - wipes out whatever has been added | 20130523 |
Events
Class CL_SATC_AC_TEXT_HANDLE_COMMON has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_POOL_MESSAGE_OF_PROGRAM | Public | See coding | Program with text element and replacement rules | 20130523 | begin of ty_Pool_Message_Of_Program,
program_Name type syrepid,
text_Pool_Message type ty_Text_Pool_Message,
end of ty_Pool_Message_Of_Program
|
|
| 2 | TY_REPLACEMENT_RULE | Public | See coding | Replacement rule; wildcard to actual value | 20130523 | begin of ty_Replacement_Rule,
wildcard type c length 8,
value type string,
end of ty_Replacement_Rule
|
|
| 3 | TY_REPLACEMENT_RULES | Public | See coding | Replacement rules; wildcard to actual value | 20130523 | ty_Replacement_Rules type standard table of ty_Replacement_Rule with default key
|
|
| 4 | TY_T100_MESSAGES | Public | See coding | Texts in T100 format | 20130523 | ty_T100_Messages type standard table of symsg with default key
|
|
| 5 | TY_TEXT_POOL_MESSAGE | Public | See coding | Text element + replacement rules | 20130523 | begin of ty_Text_Pool_Message,
key type c length 4,
replacement_Rules type ty_Replacement_Rules,
end of ty_Text_Pool_Message
|
|
| 6 | TY_TEXT_POOL_MESSAGES | Public | See coding | Text elements + replacement rules | 20130523 | ty_Text_Pool_Messages type standard table of ty_Text_Pool_Message
with default key
|
Method Signatures
Method ADD_CODE_LOCATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | STRING | Description of the location (if initial INCLUDE and LINE) | 20130523 | |||
| 2 | I_INCLUDE_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The include of the location | 20130523 | |||
| 3 | I_LINE_NBR | Call by reference | Type reference (TYPE) | I | The line of the location | 20130523 | |||
| 4 | I_PROMOTE_TO_STABLE_KEY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Promote method includes to method names ... | 20130523 |
Method ADD_CODE_LOCATION on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_CODE_LOCATION_POOL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | TY_POOL_MESSAGE_OF_PROGRAM | Description of the location | 20130523 | |||
| 2 | I_INCLUDE_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The include of the location | 20130523 | |||
| 3 | I_LINE_NBR | Call by reference | Type reference (TYPE) | I | The line of the location | 20130523 | |||
| 4 | I_PROMOTE_TO_STABLE_KEY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Promote method includes to method names ... | 20130523 |
Method ADD_CODE_LOCATION_POOL on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_CODE_LOCATION_T100 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | SYMSG | Description of the location | 20130523 | |||
| 2 | I_INCLUDE_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The include of the location | 20130523 | |||
| 3 | I_LINE_NBR | Call by reference | Type reference (TYPE) | I | The line of the location | 20130523 | |||
| 4 | I_PROMOTE_TO_STABLE_KEY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Promote method includes to method names ... | 20130523 |
Method ADD_CODE_LOCATION_T100 on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_METHOD_LOCATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_CLASS_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The name of a global class | 20130523 | |||
| 2 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | STRING | Description associated with method location | 20130523 | |||
| 3 | I_LINE_NBR | Call by reference | Type reference (TYPE) | I | A line number within the method | 20130523 | |||
| 4 | I_METHOD_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The name of a method within the global class | 20130523 |
Method ADD_METHOD_LOCATION on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_METHOD_LOCATION_POOL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_CLASS_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The name of a global class | 20130523 | |||
| 2 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | TY_POOL_MESSAGE_OF_PROGRAM | Description associated with method location | 20130523 | |||
| 3 | I_LINE_NBR | Call by reference | Type reference (TYPE) | I | A line number within the method | 20130523 | |||
| 4 | I_METHOD_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The name of a method within the global class | 20130523 |
Method ADD_METHOD_LOCATION_POOL on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_METHOD_LOCATION_T100 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_CLASS_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The name of a global class | 20130523 | |||
| 2 | I_DESCRIPTION | Call by reference | Type reference (TYPE) | SYMSG | Description associated with method location | 20130523 | |||
| 3 | I_LINE_NBR | Call by reference | Type reference (TYPE) | I | A line number within the method | 20130523 | |||
| 4 | I_METHOD_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | The name of a method within the global class | 20130523 |
Method ADD_METHOD_LOCATION_T100 on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_STRING | Call by reference | Type reference (TYPE) | STRING | 20130523 |
Method ADD_STRING on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_STRINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_STRINGS | Call by reference | Type reference (TYPE) | STRING_TABLE | Texts | 20130523 |
Method ADD_STRINGS on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_T100_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_T100_MESSAGE | Call by reference | Type reference (TYPE) | SYMSG | Text in T100 format | 20130523 |
Method ADD_T100_MESSAGE on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_T100_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_T100_MESSAGES | Call by reference | Type reference (TYPE) | TY_T100_MESSAGES | Texts in T100 format | 20130523 |
Method ADD_T100_MESSAGES on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_TEXT_POOL_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PROGRAM_NAME | Call by reference | Type reference (TYPE) | SYREPID | Program containing text element | 20130523 | |||
| 2 | I_TEXT_POOL_MESSAGE | Call by reference | Type reference (TYPE) | TY_TEXT_POOL_MESSAGE | Text element + replacement rules | 20130523 |
Method ADD_TEXT_POOL_MESSAGE on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method ADD_TEXT_POOL_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PROGRAM_NAME | Call by reference | Type reference (TYPE) | SYREPID | Program containing text element | 20130523 | |||
| 2 | I_TEXT_POOL_MESSAGES | Call by reference | Type reference (TYPE) | TY_TEXT_POOL_MESSAGES | Text element + replacement rules | 20130523 |
Method ADD_TEXT_POOL_MESSAGES on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
Method RESET Signature
Method RESET on class CL_SATC_AC_TEXT_HANDLE_COMMON has no parameter.
Method RESET on class CL_SATC_AC_TEXT_HANDLE_COMMON has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |