SAP ABAP Interface IF_GRFN_API_BR (Business rule api)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC (Application Component) Governance, Risk and Compliance
⤷
GRFN_ENTITY_API (Package) GRC Foundation API
GRCFND_A (Software Component) GRC Foundation ABAP⤷
GRC (Application Component) Governance, Risk and Compliance⤷
GRFN_ENTITY_API (Package) GRC Foundation API
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_GRFN_API_BR | Business rule API | 20091019 |
Properties
| Interface | IF_GRFN_API_BR | |
| Short Description | Business rule api |
General Data
| Package | GRFN_ENTITY_API | GRC Foundation API |
| Created | 20091019 | SAP |
| Last changed | 20141106 | |
| 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) |
Interfaces
Interface IF_GRFN_API_BR has no interface.
Friends
Interface IF_GRFN_API_BR has no friend.
Attributes
Interface IF_GRFN_API_BR has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE |
Static method | Public | Method | Creates a business rule | 20091111 |
| 2 | DELETE |
Instance method | Public | Method | Delete a rule | 20091106 |
| 3 | EXIST |
Instance method | Public | Method | Check whether object exists | 20091125 |
| 4 | QUERY |
Static method | Public | Method | [Obsolete] Use SEARCH method if possible | 20091019 |
| 5 | QUERY_F4 |
Static method | Public | Method | Query business rules ( F4 usage only ) | 20100621 |
| 6 | RETRIEVE |
Instance method | Public | Method | Retrieve a specified rule | 20091019 |
| 7 | SEARCH |
Static method | Public | Method | Search BR | 20100622 |
| 8 | UPDATE |
Instance method | Public | Method | Update a specified rule | 20091019 |
| 9 | UPDATE_STATUS |
Instance method | Public | Method | Update BR status | 20100809 |
Events
Interface IF_GRFN_API_BR has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_BR_BRFP | Public | See coding | 20120314 | BEGIN OF s_br_brfp,
br_bf_explistid TYPE grfn_explistid,
br_bf_brfpseq TYPE grfn_brfpseq,
br_bf_brfpfunction TYPE grfn_brfpuuid,
br_bf_brfpfuncname TYPE grfn_brfpfuncname,
br_bf_brfpfunctype TYPE grfn_brfpfunctype,
br_bf_brfpfuncversion TYPE grfn_brfpfuncversion,
br_bf_brfpadtpara TYPE grfn_brfpadtpara,
br_bf_brversion TYPE grfn_brversion,
END OF s_br_brfp
|
||
| 2 | S_BR_CAL_FIELD | Public | See coding | 20120314 | BEGIN OF s_br_cal_field,
br_cf_fieldid TYPE grfn_amfieldid,
br_cf_brfpdataobj TYPE grfn_brfpuuid,
br_cf_fdanystype TYPE grfn_fdanystype,
br_cf_fieldtype TYPE grfn_fieldtype,
br_cf_length TYPE grfn_amlength,
br_cf_decimals TYPE grfn_amdecimals,
br_cf_curoruom TYPE grfn_amcuroruom,
br_cf_explistid TYPE grfn_explistid,
br_cf_reffieldid TYPE grfn_amreffieldid,
br_cf_brversion TYPE grfn_brversion,
END OF s_br_cal_field
|
||
| 3 | S_BR_CONF | Public | See coding | 20120314 | BEGIN OF s_br_conf,
br_conf_brhandlername TYPE grfn_handler_object,
br_conf_brhandlertype TYPE grfn_handler_type,
br_conf_brtablename1 TYPE grfn_tabname,
br_conf_brtablename2 TYPE grfn_tabname,
br_conf_brtablename3 TYPE grfn_tabname,
br_conf_brtablename4 TYPE grfn_tabname,
br_conf_brtablename5 TYPE grfn_tabname,
br_conf_brtablename6 TYPE grfn_tabname,
br_conf_brversion TYPE grfn_brversion,
br_conf_table TYPE grfn_t_table_list,
END OF s_br_conf
|
||
| 4 | S_BR_CONNECTOR | Public | See coding | 20120314 | BEGIN OF s_br_connector,
br_conn_applied TYPE grfn_connector_applied_to_br,
br_conn_connectorid TYPE grfn_connectorid,
br_conn_brversion TYPE grfn_brversion,
END OF s_br_connector
|
||
| 5 | S_BR_DEFICIENCY | Public | See coding | 20120314 | BEGIN OF s_br_deficiency,
br_dd_fieldid TYPE grfn_amfieldid,
br_dd_anysind TYPE grfn_anysind,
br_dd_mulanysind TYPE grfn_mulanysind,
br_dd_defdesc TYPE grfn_defdesc,
br_dd_brversion TYPE grfn_brversion,
END OF s_br_deficiency
|
||
| 6 | S_BR_EXP_LIST | Public | See coding | 20120314 | BEGIN OF s_br_exp_list,
br_el_explistid TYPE grfn_explistid,
br_el_fieldid TYPE grfn_amfieldid,
br_el_outputseq TYPE grfn_outputseq,
br_el_hidden TYPE grfn_hidden_flag,
br_el_brversion TYPE grfn_brversion,
END OF s_br_exp_list
|
||
| 7 | S_BR_FIELD | Public | See coding | 20120314 | BEGIN OF s_br_field,
br_fd_fieldid TYPE grfn_amfieldid,
br_fd_fdanystype TYPE grfn_fdanystype,
br_fd_brfpdataobj TYPE grfn_brfpuuid,
br_fd_datarelevent TYPE grfn_datarelevent,
br_fd_brversion TYPE grfn_brversion,
END OF s_br_field
|
||
| 8 | S_BR_FIELD_DESCR | Public | See coding | 20120314 | BEGIN OF s_br_field_descr,
br_fdd_fieldid TYPE grfn_amfieldid,
br_fdd_fieldaltdesc TYPE grfn_amfielddesc,
br_fdd_fielddesc TYPE grfn_amfielddesc,
br_fdd_brversion TYPE grfn_brversion,
END OF s_br_field_descr
|
||
| 9 | S_BR_SELECTION | Public | See coding | 20120314 | BEGIN OF s_br_selection,
br_fs_fieldid TYPE grfn_amfieldid,
br_fs_anysind TYPE grfn_anysind,
br_fs_mulanysind TYPE grfn_mulanysind,
br_fs_selname TYPE grfn_selname,
br_fs_sign TYPE grfn_selsign,
br_fs_option TYPE grfn_seloption,
br_fs_high TYPE grfn_selvalue,
br_fs_low TYPE grfn_selvalue,
br_fs_brversion TYPE grfn_brversion,
END OF s_br_selection
|
||
| 10 | S_BR_TECH_INFO | Public | See coding | 20120314 | BEGIN OF s_br_tech_info,
br_ti_parname TYPE grfn_parname,
br_ti_parvalue TYPE grfn_parvalue,
br_ti_brversion TYPE grfn_brversion,
END OF s_br_tech_info
|
||
| 11 | S_DATA | Public | See coding | 20120314 | BEGIN OF s_data,
id TYPE grfn_api_object_id,
name TYPE t_name,
descr TYPE t_descr,
validfrom TYPE grfn_begda,
validto TYPE grfn_endda,
br_usage TYPE grfn_brusage,
br_type TYPE grfn_brtype,
br_category TYPE grfn_brcategory,
br_anystype TYPE grfn_branystype,
br_anysind TYPE grfn_anysind,
br_status TYPE grfn_brstatus,
br_brgroup TYPE grfn_brgroup,
br_searchterm TYPE grfn_searchterm,
br_brversion TYPE grfn_brversion,
br_field TYPE t_br_field,
br_cal_field TYPE t_br_cal_field,
br_selection TYPE t_br_selection,
br_tech_info TYPE t_br_tech_info,
br_field_descr TYPE t_br_field_descr,
br_brfp TYPE t_br_brfp,
br_exp_list TYPE t_br_exp_list,
br_deficiency TYPE t_br_deficiency,
br_conn TYPE t_br_connector,
br_conf TYPE s_br_conf,
eo_id TYPE grfn_api_object_id,
tp_flag TYPE grfn_template_flag,
END OF s_data
|
||
| 12 | S_DESCR | Public | See coding | 20120314 | BEGIN OF s_descr,
descr TYPE grfn_text,
lang TYPE laiso,
END OF s_descr
|
||
| 13 | S_NAME | Public | See coding | 20120314 | BEGIN OF s_name,
name TYPE grfn_name,
lang TYPE laiso,
END OF s_name
|
||
| 14 | T_BR_BRFP | Public | See coding | 20120314 | t_br_brfp TYPE STANDARD TABLE OF s_br_brfp WITH DEFAULT KEY
|
||
| 15 | T_BR_CAL_FIELD | Public | See coding | 20120314 | t_br_cal_field TYPE STANDARD TABLE OF s_br_cal_field WITH DEFAULT KEY
|
||
| 16 | T_BR_CONNECTOR | Public | See coding | 20120314 | t_br_connector TYPE STANDARD TABLE OF s_br_connector WITH DEFAULT KEY
|
||
| 17 | T_BR_DEFICIENCY | Public | See coding | 20120314 | t_br_deficiency TYPE STANDARD TABLE OF s_br_deficiency WITH DEFAULT KEY
|
||
| 18 | T_BR_EXP_LIST | Public | See coding | 20120314 | t_br_exp_list TYPE STANDARD TABLE OF s_br_exp_list WITH DEFAULT KEY
|
||
| 19 | T_BR_FIELD | Public | See coding | 20120314 | t_br_field TYPE STANDARD TABLE OF s_br_field WITH DEFAULT KEY
|
||
| 20 | T_BR_FIELD_DESCR | Public | See coding | 20120314 | t_br_field_descr TYPE STANDARD TABLE OF s_br_field_descr WITH DEFAULT KEY
|
||
| 21 | T_BR_SELECTION | Public | See coding | 20120314 | t_br_selection TYPE STANDARD TABLE OF s_br_selection WITH DEFAULT KEY
|
||
| 22 | T_BR_TECH_INFO | Public | See coding | 20120314 | t_br_tech_info TYPE STANDARD TABLE OF s_br_tech_info WITH DEFAULT KEY
|
||
| 23 | T_DATA | Public | See coding | 20120314 | t_data TYPE STANDARD TABLE OF s_data WITH DEFAULT KEY
|
||
| 24 | T_DESCR | Public | See coding | 20120314 | t_descr TYPE STANDARD TABLE OF s_descr WITH DEFAULT KEY
|
||
| 25 | T_NAME | Public | See coding | 20120314 | t_name TYPE STANDARD TABLE OF s_name WITH DEFAULT KEY
|
Method Signatures
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20091111 | ||
| 2 | Importing |
IS_BR | Call by reference | Type reference (TYPE) | GRFN_S_API_BR | Business rule | 20091120 | ||
| 3 |  Returning |
RV_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091111 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091111 |
Method DELETE Signature
Method DELETE on Interface IF_GRFN_API_BR has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091112 |
Method EXIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20091125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100317 |
Method QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_BR | Call by reference | Type reference (TYPE) | GRFN_T_API_OBJECT | Table of business rule | 20091019 | ||
| 2 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20091019 | ||
| 3 | Importing |
IV_PATTERN | Call by reference | Type reference (TYPE) | GRFN_API_SEARCH_PATTERN | API search pattern | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
20091020 |
Method QUERY_F4 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_BR | Call by reference | Type reference (TYPE) | GRFN_T_API_OBJECT | Table of business rule | 20100621 | ||
| 2 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100621 | ||
| 3 | Importing |
IV_ONLY_READ_TEMPLATE | Call by reference | Type reference (TYPE) | GRFN_BOOLEAN | Indicator | 20120717 | ||
| 4 | Importing |
IV_PATTERN | Call by reference | Type reference (TYPE) | GRFN_API_SEARCH_PATTERN | API search pattern | 20100621 | ||
| 5 | Importing |
IV_SUBSCENARIO | Call by reference | Type reference (TYPE) | GRFN_SUBSCENARIO | Sub Scenario Definition | 20100621 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
20100621 |
Method RETRIEVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_BR | Call by reference | Type reference (TYPE) | GRFN_S_API_BR | Business rule | 20091019 | ||
| 2 | Exporting |
EV_EO | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091112 | ||
| 3 | Importing |
IV_EDITABLE | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20091019 | ||
| 4 | Importing |
IV_VERSION | Call by reference | Type reference (TYPE) | GRFN_BRVERSION | Natural number | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
20091020 |
Method SEARCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_BR | Call by reference | Type reference (TYPE) | GRFN_T_API_BR | Business rules | 20100622 | ||
| 2 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100622 | ||
| 3 | Importing |
IT_SEARCH_OPTION | Call by reference | Type reference (TYPE) | GRFN_T_QUERY_OPTION | Field Query Options | 20120405 | ||
| 4 | Importing |
IV_AUTH_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Authorization check | 20120511 | |
| 5 | Importing |
IV_ONLY_READ_TEMPLATE | Call by reference | Type reference (TYPE) | GRFN_BOOLEAN | Indicator | 20120717 | ||
| 6 | Importing |
IV_PATTERN | Call by reference | Type reference (TYPE) | GRFN_API_SEARCH_PATTERN | API search pattern | 20100622 | ||
| 7 | Importing |
IV_READ_HEADER | Call by reference | Type reference (TYPE) | GRFN_BOOLEAN | Read BR header info | 20100702 | ||
| 8 | Importing |
IV_READ_LONGTEXT | Call by reference | Type reference (TYPE) | GRFN_BOOLEAN | Read BR text info | 20100622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100622 |
Method UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_BR | Call by reference | Type reference (TYPE) | GRFN_S_API_BR | Business rule | 20091019 | ||
| 2 | Importing |
IV_BATCH_MODE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120522 | ||
| 3 | Importing |
IV_EO | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091112 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
20091020 |
Method UPDATE_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_STATUS | Call by reference | Type reference (TYPE) | GRFN_BRSTATUS | Status for the business rule | 20100809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100809 |
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 600 |
