SAP ABAP Class CL_GRFN_UTIL_CDF (Custom fields functions)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC (Application Component) Governance, Risk and Compliance
⤷
GRFN_UTILITIES (Package) Various helping infrastructure for GRC ABAP
GRCFND_A (Software Component) GRC Foundation ABAP⤷
GRC (Application Component) Governance, Risk and Compliance⤷
GRFN_UTILITIES (Package) Various helping infrastructure for GRC ABAPProperties
| Class | CL_GRFN_UTIL_CDF | |
| Short Description | Custom fields functions | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | GRFN_UTILITIES | Various helping infrastructure for GRC ABAP |
| Created | 20080723 | SAP |
| Last change | 20141106 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  GRPC0 |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | GRPCB |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_GRFN_UTIL_CDF has no interface implemented.
Friends
Class CL_GRFN_UTIL_CDF has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_DDIC_MUTLIVALUE_STRU_PREFIX |
Constant | Private | Type reference (TYPE) | DDOBJNAME | 'ZGRCS_' | Prefix for generated DDIC tables for multi value fields | 20091127 | |
| 2 | C_DDIC_MUTLIVALUE_TAB_PREFIX |
Constant | Private | Type reference (TYPE) | DDOBJNAME | 'ZGRCT_' | Prefix for generated DDIC tables for multi value fields | 20091127 | |
| 3 | C_STORAGE_TYPE_CI |
Constant | Public | Type reference (TYPE) | GRFN_FIELD_STORAGE_TYPE | 'CI' | DDIC Customer include | 20091127 | |
| 4 | C_STORAGE_TYPE_I2 |
Constant | Public | Type reference (TYPE) | GRFN_FIELD_STORAGE_TYPE | 'I2' | Infotype - time constraint 2 | 20091127 | |
| 5 | C_STORAGE_TYPE_I3 |
Constant | Public | Type reference (TYPE) | GRFN_FIELD_STORAGE_TYPE | 'I3' | Infotype - time constraint 3 | 20091127 | |
| 6 | C_STORAGE_TYPE_IT |
Constant | Public | Type reference (TYPE) | GRFN_FIELD_STORAGE_TYPE | 'IT' | Infotype 1002 - long texts | 20091127 | |
| 7 | C_STORAGE_TYPE_TM |
Constant | Public | Type reference (TYPE) | GRFN_FIELD_STORAGE_TYPE | 'TM' | DDIC multiple value (additional generated tables) | 20091216 | |
| 8 | C_TEXTAREA_LENGTH |
Constant | Public | Type reference (TYPE) | I | 120 | Field length which is interpereted as text area | 20080723 | |
| 9 | C_UI_MODE_EDITABLE |
Constant | Public | Type reference (TYPE) | GRFN_CDF_UI_MODE | ' ' | Field mode | 20091210 | |
| 10 | C_UI_MODE_HIDDEN |
Constant | Public | Type reference (TYPE) | GRFN_CDF_UI_MODE | 'H' | Field mode | 20091210 | |
| 11 | C_UI_MODE_READ_ONLY |
Constant | Public | Type reference (TYPE) | GRFN_CDF_UI_MODE | 'R' | Field mode | 20091210 | |
| 12 | C_UI_TYPE_CBOX |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'CBOX' | Checkbox | 20080724 | |
| 13 | C_UI_TYPE_DATE |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'DATE' | Date Field | 20080724 | |
| 14 | C_UI_TYPE_DDLB |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'DDLB' | Dropdown List Box | 20080724 | |
| 15 | C_UI_TYPE_ICON |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'ICON' | Icon | 20080724 | |
| 16 | C_UI_TYPE_LINK |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'LINK' | Link | 20120907 | |
| 17 | C_UI_TYPE_MCBX |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'MCBX' | Multiple Checkbox | 20091204 | |
| 18 | C_UI_TYPE_NUMC |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'NUMC' | Text Field Numeric | 20080724 | |
| 19 | C_UI_TYPE_RBGP |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'RBGP' | Radiobutton Group | 20080724 | |
| 20 | C_UI_TYPE_TIME |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'TIME' | Time Field | 20080724 | |
| 21 | C_UI_TYPE_TXTA |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'TXTA' | Text Area | 20080724 | |
| 22 | C_UI_TYPE_TXTC |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | 'TXTC' | Text Field Case Sensitive | 20080724 | |
| 23 | C_UI_TYPE_TXTN |
Constant | Public | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | ' ' | Text Field | 20080724 | |
| 24 | MT_API_MDATA |
Static Attribute | Private | Type reference (TYPE) | YT_API_MDATA | Temporary API metadata buffer for entity | 20091127 | ||
| 25 | MT_DD02L |
Static Attribute | Private | Type reference (TYPE) | YT_DD02L | 20091127 | |||
| 26 | MT_MCF |
Static Attribute | Private | Type reference (TYPE) | YT_MCF | 20080815 | |||
| 27 | MT_METADATA |
Static Attribute | Private | Type reference (TYPE) | YT_METADATA | 20091118 | |||
| 28 | MT_OBJECT_CONT |
Static Attribute | Private | Type reference (TYPE) | GRFN_T_OBJECT_CONT | InfoTypes per Object Type table | 20080723 | ||
| 29 | MT_SUBTYPETXT |
Static Attribute | Private | Type reference (TYPE) | YT_T777U | 20090210 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | API_RETRIEVE_CUSTOMFIELD |
Static method | Public | Method | To be called from CDF interface in Entity API | 20091125 |
| 2 | API_UPDATE_CUSTOMFIELD |
Static method | Public | Method | To be called from CDF interface in Entity API | 20091125 |
| 3 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20080723 |
| 4 | DETERMINE_UITYPE |
Static method | Private | Method | Determine UI type for DDIC type | 20080723 |
| 5 | GET_ENTITY_METADATA |
Static method | Public | Method | Build metadata for spefified entity | 20091126 |
| 6 | GET_ENTITY_TABLE |
Static method | Private | Method | NOT USED | 20091204 |
| 7 | IS_INITIAL |
Static method | Private | Method | Check if field is initial | 20080724 |
| 8 | PARSE_DATA_ELEMENT_METADATA |
Static method | Public | Method | Convert data element to metadata | 20120522 |
| 9 | PARSE_STRUCTURE_METADATA |
Static method | Private | Method | Convert structure to metadata | 20091127 |
Events
Class CL_GRFN_UTIL_CDF has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | YS_API_MDATA | Private | See coding | 20091127 | begin of ys_api_mdata.
types entity_id type grfn_api_entity_id.
types regulation_id type grfn_api_object_id.
types t_api_mdata type grfn_t_api_customfield_mdata.
types end of ys_api_mdata
|
||
| 2 | YS_MCF | Private | See coding | 20080815 | begin of ys_mcf.
types entity_id type grfn_api_entity_id.
types t_mcf type grpc_t_mcf_cusfld.
types end of ys_mcf
|
||
| 3 | YS_METADATA | Private | See coding | 20091118 | begin of ys_metadata.
types entity_id type grfn_api_entity_id.
types infix type char20.
types t_metadata type grfn_t_field_metadata.
types end of ys_metadata
|
||
| 4 | YT_API_MDATA | Private | See coding | 20091127 | yt_api_mdata type sorted table of ys_api_mdata with unique key entity_id regulation_id
|
||
| 5 | YT_DD02L | Private | See coding | 20091127 | yt_dd02l type sorted table of dd02l with unique key tabname as4local as4vers
|
||
| 6 | YT_MCF | Private | See coding | 20080815 | yt_mcf type sorted table of ys_mcf with unique key entity_id
|
||
| 7 | YT_METADATA | Private | See coding | 20091118 | yt_metadata type sorted table of ys_metadata with unique key entity_id infix
|
||
| 8 | YT_T777U | Private | See coding | 20090210 | yt_t777u type table of t777u
|
Method Signatures
Method API_RETRIEVE_CUSTOMFIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_CUSTOMFIELD_DATA | Call by reference | Type reference (TYPE) | GRFN_T_API_CUSTOMFIELD_DATA | CDF Data | 20091125 | ||
| 2 | Exporting |
ET_CUSTOMFIELD_MDATA | Call by reference | Type reference (TYPE) | GRFN_T_API_CUSTOMFIELD_MDATA | 20091125 | |||
| 3 | Exporting |
EV_REG_SPECIFIC | Call by reference | Type reference (TYPE) | GRPC_REG_SPEC_DATA_FLAG | Regulation specific data | 20100119 | ||
| 4 |  Importing |
IO_MODEL | Value transfer | Object reference (TYPE REF TO) | IF_GRFN_API_CUSTOMFIELD_MODEL | Model extension to handle the custom fields | 20091125 | ||
| 5 | Importing |
IV_NO_HR_ENTITY | Value transfer | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID provided in case CDF is for not HR based | 20091125 | ||
| 6 | Importing |
IV_OBJECT_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091125 | ||
| 7 | Importing |
IV_REGULATION_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Regulation | 20091125 | ||
| 8 | Importing |
IV_SESSION_ID | Value transfer | Type reference (TYPE) | GRFN_API_SESSION_ID | ID of GRC session | 20091125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091125 |
Method API_UPDATE_CUSTOMFIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MODEL | Value transfer | Object reference (TYPE REF TO) | IF_GRFN_API_CUSTOMFIELD_MODEL | Model extension to handle the custom fields | 20091125 | ||
| 2 | Importing |
IT_CUSTOMFIELD_DATA | Call by reference | Type reference (TYPE) | GRFN_T_API_CUSTOMFIELD_DATA | Customer defined fields | 20091125 | ||
| 3 | Importing |
IV_OBJECT_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091125 | ||
| 4 | Importing |
IV_REGULATION_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Regulation | 20091125 | ||
| 5 | Importing |
IV_SESSION_ID | Value transfer | Type reference (TYPE) | GRFN_API_SESSION_ID | ID of GRC session | 20091125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091125 |
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_GRFN_UTIL_CDF has no parameter.
Method CLASS_CONSTRUCTOR on class CL_GRFN_UTIL_CDF has no exception.
Method DETERMINE_UITYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
EV_UITYPE | Value transfer | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_UI_TYPE | UI Type of the Customer Defined Field | 20080723 | ||
| 2 | Importing |
IO_DDIC | Call by reference | Object reference (TYPE REF TO) | CL_ABAP_ELEMDESCR | Runtime Type Services | 20080723 | ||
| 3 | Importing |
IV_MULTI_VALUE | Call by reference | Type reference (TYPE) | XFLAG | New Input Values | 20091204 |
Method DETERMINE_UITYPE on class CL_GRFN_UTIL_CDF has no exception.
Method GET_ENTITY_METADATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_METADATA | Call by reference | Type reference (TYPE) | GRFN_T_FIELD_METADATA | CDF Metadata | 20091126 | ||
| 2 | Importing |
IV_ENTITY_ID | Value transfer | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID | 20091126 | ||
| 3 | Importing |
IV_INFIX | Value transfer | Type reference (TYPE) | STRING | 20100113 | |||
| 4 | Importing |
IV_OBJECT_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20100113 |
Method GET_ENTITY_METADATA on class CL_GRFN_UTIL_CDF has no exception.
Method GET_ENTITY_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_TAB | Value transfer | Type reference (TYPE) | TABNAME | Table Name | 20091204 | ||
| 2 | Importing |
IV_ENTITY_ID | Call by reference | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID | 20091204 |
Method GET_ENTITY_TABLE on class CL_GRFN_UTIL_CDF has no exception.
Method IS_INITIAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_INITIAL | Value transfer | Type reference (TYPE) | AS4FLAG | 20080724 | |||
| 2 | Importing |
IV_DDIC_TYPE | Call by reference | Type reference (TYPE) | ROLLNAME | 20100720 | |||
| 3 | Importing |
IV_VALUE | Call by reference | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_VALUE | Value of the customer defined field | 20080724 |
Method IS_INITIAL on class CL_GRFN_UTIL_CDF has no exception.
Method PARSE_DATA_ELEMENT_METADATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_METADATA | Call by reference | Type reference (TYPE) | GRFN_S_FIELD_METADATA | CDF FIeld Metadata | 20120522 | ||
| 2 | Importing |
IV_DATA_ELEMENT | Value transfer | Type reference (TYPE) | TABNAME | 20120522 | |||
| 3 | Importing |
IV_FIELD_NAME | Value transfer | Type reference (TYPE) | GRFN_API_CUSTOMFIELD_NAME | Name of the Custom Field | 20120522 | ||
| 4 | Importing |
IV_INFTY | Value transfer | Type reference (TYPE) | INFTY | Infotype | 20120522 | ||
| 5 | Importing |
IV_MULTI_VALUE | Value transfer | Type reference (TYPE) | XFLAG | New Input Values | 20120522 | ||
| 6 | Importing |
IV_OBJTYPE | Value transfer | Type reference (TYPE) | GRFN_OBJTYPE | Object Type. | 20120522 | ||
| 7 | Importing |
IV_OTYPE | Value transfer | Type reference (TYPE) | OTYPE | Object Type | 20120522 | ||
| 8 | Importing |
IV_REGULATION_VALUE | Value transfer | Type reference (TYPE) | XFLAG | New Input Values | 20120522 | ||
| 9 | Importing |
IV_STORAGE_TYPE | Value transfer | Type reference (TYPE) | GRFN_FIELD_STORAGE_TYPE | CDF storage type | 20120522 | ||
| 10 | Importing |
IV_SUBTY | Value transfer | Type reference (TYPE) | SUBTY | Subtype | 20120522 | ||
| 11 | Importing |
IV_TYPE | Value transfer | Type reference (TYPE) | GRFN_OBJTYPE_TYP | Usage Type | 20120522 |
Method PARSE_DATA_ELEMENT_METADATA on class CL_GRFN_UTIL_CDF has no exception.
Method PARSE_STRUCTURE_METADATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_METADATA | Call by reference | Type reference (TYPE) | GRFN_T_FIELD_METADATA | 20091127 | |||
| 2 | Importing |
IV_DDIC_TABLE | Value transfer | Type reference (TYPE) | TABNAME | 20091127 | |||
| 3 | Importing |
IV_INFTY | Value transfer | Type reference (TYPE) | INFTY | Infotype | 20091127 | ||
| 4 | Importing |
IV_MULTI_VALUE | Value transfer | Type reference (TYPE) | XFLAG | New Input Values | 20091127 | ||
| 5 | Importing |
IV_OBJTYPE | Value transfer | Type reference (TYPE) | GRFN_OBJTYPE | Object Type. | 20091208 | ||
| 6 | Importing |
IV_OTYPE | Value transfer | Type reference (TYPE) | OTYPE | Object Type | 20091127 | ||
| 7 | Importing |
IV_REGULATION_VALUE | Value transfer | Type reference (TYPE) | XFLAG | New Input Values | 20091127 | ||
| 8 | Importing |
IV_STORAGE_TYPE | Value transfer | Type reference (TYPE) | GRFN_FIELD_STORAGE_TYPE | CDF storage type | 20091127 | ||
| 9 | Importing |
IV_STRUCTURE | Value transfer | Type reference (TYPE) | TABNAME | 20091127 | |||
| 10 | Importing |
IV_SUBTY | Value transfer | Type reference (TYPE) | SUBTY | Subtype | 20091127 | ||
| 11 | Importing |
IV_TYPE | Value transfer | Type reference (TYPE) | GRFN_OBJTYPE_TYP | Usage Type | 20091208 |
Method PARSE_STRUCTURE_METADATA on class CL_GRFN_UTIL_CDF has no exception.
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 300 |
