SAP ABAP Class IDREPFW_CL_KEY_GROUP (Rep.Framework: Grouping of keys)
Hierarchy
☛
SAP_FIN (Software Component) SAP_FIN
⤷
FI-LOC (Application Component) Localization
⤷
ID-REP_FRWK (Package) International Development: Reporting Framework
⤷
⤷
Properties
| Class | IDREPFW_CL_KEY_GROUP | |
| Short Description | Rep.Framework: Grouping of keys | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ID-REP_FRWK | International Development: Reporting Framework |
| Created | 20120510 | SAP |
| Last change | 20130531 | 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) |
Interfaces
Class IDREPFW_CL_KEY_GROUP has no interface implemented.
Friends
Class IDREPFW_CL_KEY_GROUP has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Type reference (TYPE) | IDREPFW_STR_CGRP_KEY | Rep.Framework: Combination of key fields to Column Group | 20120528 | |||
| 2 | Static Attribute | Private | Type reference (TYPE) | IDREPFW_CH_SEPARATOR | Character Separator | 20120528 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | Constructor | 20120510 | |
| 2 | Instance method | Protected | Method | Gets columns of a group from db - instance version. | 20120516 | |
| 3 | Static method | Public | Method | Gets columns of a group from db | 20120516 | |
| 4 | Static method | Public | Method | Splits Internal Key formed by Group Separator | 20120525 | |
| 5 | Instance method | Public | Method | Gets key values from user and returns internal key | 20120516 | |
| 6 | Instance method | Protected | Method | Gets the separator of the group | 20120517 | |
| 7 | Instance method | Protected | Method | Shows popup to get values | 20120516 | |
| 8 | Instance method | Public | Method | Validates the key | 20120516 |
Events
Class IDREPFW_CL_KEY_GROUP has no event.
Types
Class IDREPFW_CL_KEY_GROUP has no local type.
Method Signatures
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class IDREPFW_CL_KEY_GROUP has no parameter.
Method CONSTRUCTOR on class IDREPFW_CL_KEY_GROUP has no exception.
Method GET_COLUMNS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_COLUMNS | Call by reference | Type reference (TYPE) | IDREPFW_TAB_GRP_COLUMNS | Rep.Framework: Columns of a group | 20120516 | |||
| 2 | IS_REP_KEYS | Call by reference | Type reference (TYPE) | IDREPFW_STR_REP_KEY | Rep.Framework: Combination of key fields: Group,ID,Versn | 20120530 | |||
| 3 | IV_GROUPC | Call by reference | Type reference (TYPE) | IDREPFW_GROUPC | Group of Columns - Field Names | 20120516 | |||
| 4 | IV_SECT_ID | Call by reference | Type reference (TYPE) | IDREPFW_REP_SECTION_ID | Report Section ID | 20120530 |
Method GET_COLUMNS on class IDREPFW_CL_KEY_GROUP has no exception.
Method GET_GROUP_COLUMNS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_COLUMNS | Call by reference | Type reference (TYPE) | IDREPFW_TAB_GRP_COLUMNS | Rep.Framework: Columns of a group | 20120516 | |||
| 2 | IS_GROUPC | Call by reference | Type reference (TYPE) | IDREPFW_STR_CGRP_KEY | Rep.Framework: Combination of key fields to Column Group | 20120525 |
Method GET_GROUP_COLUMNS on class IDREPFW_CL_KEY_GROUP has no exception.
Method GET_KEYS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_INTKEYS | Call by reference | Type reference (TYPE) | IDREPFW_TAB_INTKEY | Rep.Framework: List of Internal Keys | 20120525 | |||
| 2 | IS_GROUPC | Call by reference | Type reference (TYPE) | IDREPFW_STR_CGRP_KEY | Rep.Framework: Combination of key fields to Column Group | 20120528 | |||
| 3 | IV_INTKEYVALUE | Call by reference | Type reference (TYPE) | IDREPFW_INTKEY | Internal Key | 20120525 | |||
| 4 | IV_SEPARATOR | Call by reference | Type reference (TYPE) | IDREPFW_CH_SEPARATOR | Character Separator | 20120528 |
Method GET_KEYS on class IDREPFW_CL_KEY_GROUP has no exception.
Method GET_KEY_VALUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_KEY | Call by reference | Type reference (TYPE) | IDREPFW_INTKEY | Internal Key | 20120516 | |||
| 2 | IM_DISPLAY_ONLY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Display Only ('X'~display only,''~change) | 20131025 | ||
| 3 | IS_REP_KEYS | Call by reference | Type reference (TYPE) | IDREPFW_STR_REP_KEY | Rep.Framework: Combination of key fields: Group,ID,Versn | 20120530 | |||
| 4 | IV_GROUPC | Call by reference | Type reference (TYPE) | IDREPFW_GROUPC | Group of Columns - Field Names | 20120516 | |||
| 5 | IV_SECT_ID | Call by reference | Type reference (TYPE) | IDREPFW_REP_SECTION_ID | Report Section ID | 20120530 | |||
| 6 | IV_TABNAME | Call by reference | Type reference (TYPE) | TABNAME | Table Name | 20120516 |
Method GET_KEY_VALUES on class IDREPFW_CL_KEY_GROUP has no exception.
Method GET_SEPARATOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_SEPARATOR | Call by reference | Type reference (TYPE) | IDREPFW_CH_SEPARATOR | Character Separator | 20120517 | |||
| 2 | IS_REP_KEYS | Call by reference | Type reference (TYPE) | IDREPFW_STR_REP_KEY | Rep.Framework: Combination of key fields: Group,ID,Versn | 20120530 | |||
| 3 | IV_GROUPC | Call by reference | Type reference (TYPE) | IDREPFW_GROUPC | Group of Columns - Field Names | 20120517 | |||
| 4 | IV_SECT_ID | Call by reference | Type reference (TYPE) | IDREPFW_REP_SECTION_ID | Report Section ID | 20120530 |
Method GET_SEPARATOR on class IDREPFW_CL_KEY_GROUP has no exception.
Method SHOW_POPUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_TAB_FIELD | Call by reference | Type reference (TYPE) | IDREPFW_TAB_SVAL | Interface for function group SPO4 | 20120516 | |||
| 2 | EV_CODE | Call by reference | Type reference (TYPE) | CHAR10 | Character Field Length = 10 | 20120516 |
Method SHOW_POPUP on class IDREPFW_CL_KEY_GROUP has no exception.
Method VALIDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_KEY_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20120516 | |||
| 2 | IS_REP_KEYS | Call by reference | Type reference (TYPE) | IDREPFW_STR_REP_KEY | Rep.Framework: Combination of key fields: Group,ID,Versn | 20120530 | |||
| 3 | IV_GROUPC | Call by reference | Type reference (TYPE) | IDREPFW_GROUPC | Group of Columns - Field Names | 20120516 | |||
| 4 | IV_KEY | Call by reference | Type reference (TYPE) | STRING | 20120516 | ||||
| 5 | IV_SECT_ID | Call by reference | Type reference (TYPE) | IDREPFW_REP_SECTION_ID | Report Section ID | 20120530 | |||
| 6 | IV_TABNAME | Call by reference | Type reference (TYPE) | TABNAME | Table Name | 20120516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Number of key parameters differs from group definition. | 20120517 | ||
| 2 | Value of the key is incompatible with data element. | 20120517 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 607 |