SAP ABAP Interface IF_GRPC_API_CONTROL (Control API interface)
Hierarchy
GRCFND_A (Software Component) GRC Foundation ABAP
   GRC-SPC (Application Component) Process Controls
     GRPC_ENTITY_API (Package) GRC Process controls API
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_GRPC_API_CONTROL Control API class 20091020
Properties
Interface IF_GRPC_API_CONTROL  
Short Description Control API interface    
General Data
Package GRPC_ENTITY_API   GRC Process controls API 
Created 20091020   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_GRPC_API_CONTROL has no interface.
Friends
Interface IF_GRPC_API_CONTROL has no friend.
Attributes
Interface IF_GRPC_API_CONTROL has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_DEL Instance method Public Method Check whether local control Can be Deleted 20091029
2 CREATE Static method Public Method Creat a new local control 20091020
3 CREATE_AC Static method Public Method Creat a new local control for AC 20100628
4 DELETE Instance method Public Method Delete local Control 20091020
5 GET_AC_CONTROL_ID Instance method Public Method Get AC Control ID 20100226
6 GET_TYPE_TEXT Static method Public Method Get local control type text(is allow local change or not) 20100223
7 IS_CREATED_LOCALLY Instance method Public Method Whether the control is created locally 20100302
8 IS_SS_CONSUMER Instance method Public Method Whether the control is shared service consumer 20110504
9 QUERY Static method Public Method Used for retrieving the list of local control 20091020
10 RESULTS Instance method Public Method results 20091029
11 RETRIEVE Instance method Public Method Retrieve the local control data 20091020
12 RETRIEVE_AC Static method Public Method Retrieve the local control data for AC 20100225
13 RETRIEVE_REF_CONTROL Instance method Public Method Load the list of the controls 20091103
14 SEARCH Static method Public Method High level API to search controls 20091029
15 SEARCH_BY_DES Static method Public Method Search Control by Description (Name) 20091029
16 SEARCH_BY_RULE Static method Public Method Search Control by Description (Name) 20091112
17 UPDATE Instance method Public Method Update the local control 20091020
Events
Interface IF_GRPC_API_CONTROL has no event.
Types
Interface IF_GRPC_API_CONTROL has no local type.
Method Signatures

Method CHECK_DEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_ALLOWED Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20091029
2 Exporting EV_LOCKED Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20091029
3 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091029
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20091029

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 20091022
2 Importing IS_CONTROL_BDATA_NEW Call by reference Type reference (TYPE) GRPC_S_API_CONTROL_BDATA Control data for API service - basic fields 20091022
3 Importing IS_CONTROL_CDATA_NEW Call by reference Type reference (TYPE) GRPC_S_API_CONTROL_CDATA Control data for API service - control fields 20091022
4 Importing IS_CONTROL_TDATA_NEW Call by reference Type reference (TYPE) GRPC_S_API_CONTROL_TDATA Control data for API service - testing fields 20091022
5 Importing IV_ID_ONLY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Only generate ID 20100527
6 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091022
7 Returning RV_ID Value transfer Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091022
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION 20091022

Method CREATE_AC 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 20100628
2 Returning RV_ID Value transfer Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20100628
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION 20100628

Method DELETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091022
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION 20091022

Method GET_AC_CONTROL_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ID Value transfer Type reference (TYPE) GRAC_CONTROL_ID SOD Control ID 20100226
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100301

Method GET_TYPE_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CENTRAL_CONTROL Call by reference Type reference (TYPE) GRPC_API_OBJECT_ID GRPC ID of the individual object 20100223
2 Importing IV_TYPE Value transfer Type reference (TYPE) GRPC_API_CONTROL_TYP Type of controls 20100223
3 Returning RV_TYPE_TEXT Value transfer Type reference (TYPE) GRPC_TEXT Text 20100223

Method GET_TYPE_TEXT on Interface IF_GRPC_API_CONTROL has no exception.

Method IS_CREATED_LOCALLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20100302
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100302

Method IS_SS_CONSUMER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20110504
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20110504

Method QUERY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_CONTROL Call by reference Type reference (TYPE) GRPC_T_API_CONTROL_LIST Local control list 20091022
2 Importing IO_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20091022
3 Importing IT_QUERY_OPTION Call by reference Type reference (TYPE) GRFN_T_QUERY_OPTION Field Query Options 20100806
4 Importing IV_AUTOMATED_ONLY Value transfer Type reference (TYPE) XFELD ABAP_FALSE Search only for automated and semi-automated controls 20091022
5 Importing IV_CONTROL_TYP Call by reference Type reference (TYPE) GRPC_API_CONTROL_TYP Type of controls 20091022
6 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091022
7 Importing IV_SEARCH_PATTERN Value transfer Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091022
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION 20091022

Method RESULTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091029
2 Returning RS_CONTROL_STATUS Value transfer Type reference (TYPE) GRPC_S_CONTROL_STATUS Statuses of a Control 20091029
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20091029

Method RETRIEVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_CONTROL_BDATA Call by reference Type reference (TYPE) GRPC_S_API_CONTROL_BDATA Control data for API service - basic fields 20091022
2 Exporting ES_CONTROL_CDATA Call by reference Type reference (TYPE) GRPC_S_API_CONTROL_CDATA Control data for API service - control fields 20091022
3 Exporting ES_CONTROL_TDATA Call by reference Type reference (TYPE) GRPC_S_API_CONTROL_TDATA Control data for API service - testing fields 20091022
4 Exporting ET_CONTROL_ACCGROUP Call by reference Type reference (TYPE) GRPC_T_API_CONTROL_ACCGROUP Account assertions 20100818
5 Exporting ET_CONTROL_REGULATION Call by reference Type reference (TYPE) GRFN_T_API_OBJECT_ID List of Regulations 20100106
6 Exporting ET_CONTROL_RULE Call by reference Type reference (TYPE) GRPC_T_API_CONTROL_RULE Control Rule Assigment Linking Table 20091022
7 Exporting ET_REGULATION Call by reference Type reference (TYPE) GRFN_T_API_REGULATION Regulation 20091022
8 Exporting ET_REGULATION_REQ Call by reference Type reference (TYPE) GRFN_T_API_REGULATION_REQ Regulation requirements 20091022
9 Exporting ET_RELEVANCE Call by reference Type reference (TYPE) GRPC_T_API_CNTR_RELEVANCE Relevance 20091022
10 Exporting ET_RISK Call by reference Type reference (TYPE) GRPC_T_API_RISK_COVERAGE Assigned risks 20091022
11 Exporting ET_SUBGROUP Call by reference Type reference (TYPE) GRPC_T_API_CNTR_SUBGROUP Control Subgroup 20091022
12 Exporting EV_LOCKED Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20091029
13 Importing IV_EDITABLE Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Boolean Variable (X=True, -=False, Space=Unknown) 20091022
14 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRPC_API_OBJECT_ID GRPC ID of the individual object 20091022
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION 20091022

Method RETRIEVE_AC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_APPROVER Call by reference Type reference (TYPE) GRFN_S_OWNER Model structure for Central Owner Administration 20100225
2 Exporting ES_CONTROL_BDATA Call by reference Type reference (TYPE) GRPC_S_API_CONTROL_BDATA Control data for API service - basic fields 20100225
3 Exporting ET_MONITOR Call by reference Type reference (TYPE) GRFN_T_OWNER Table for AC Owner 20100225
4 Exporting ET_REPORT Call by reference Type reference (TYPE) GRFN_T_CN_REPORT Control AC Report 20100603
5 Exporting ET_RISK Call by reference Type reference (TYPE) GRFN_T_AC_RISK_RULE AC Risk ID and Rule ID 20100225
6 Importing IO_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20100225
7 Importing IV_AC_CONTROL_ID Call by reference Type reference (TYPE) GRAC_CONTROL_ID SOD Control ID 20100225
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION 20100225

Method RETRIEVE_REF_CONTROL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ET_CONTROLS Value transfer Type reference (TYPE) GRFN_T_API_OBJECT_ID Table type of control list 20091103
2 Importing IV_ORGUNIT_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091103
3 Importing IV_XCONTROL_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091103
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20091103

Method SEARCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_CONTROL_SRES Call by reference Type reference (TYPE) GRPC_T_API_CONTROL_SRES Process step search result 20100113
2 Importing IO_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Natural numberSession Management for GRC APIs 20091105
3 Importing IT_CONTROL_RANGE Call by reference Type reference (TYPE) GRPC_T_RA_API_OBJECT_ID The range table for object ID 20091029
4 Importing IT_ORGUNIT_RANGE Call by reference Type reference (TYPE) GRPC_T_RA_API_OBJECT_ID The range table for object ID 20091029
5 Importing IT_PROCESS_RANGE Call by reference Type reference (TYPE) GRPC_T_RA_API_OBJECT_ID The range table for object ID 20091029
6 Importing IT_SUBPROCESS_RANGE Call by reference Type reference (TYPE) GRPC_T_RA_API_OBJECT_ID The range table for object ID 20091029
7 Importing IV_AUTOMATED_ONLY Call by reference Type reference (TYPE) XFELD Checkbox 20091029
8 Importing IV_MAX_ROWS Call by reference Type reference (TYPE) INT4 0 Natural number 20091029
9 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID Object ID 20091029
10 Importing IV_SEARCH_PATTERN Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091029
11 Importing IV_SKIP_PROCESS_STEP Call by reference Type reference (TYPE) GRFN_BOOLEAN Boolean 20091029
12 Importing IV_SKIP_SS_CONSUMER Call by reference Type reference (TYPE) XFELD Checkbox 20091029
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20091029

Method SEARCH_BY_DES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_CONTROL_OVS Call by reference Type reference (TYPE) GRFN_T_OVS Generic type for OVS 20091125
2 Exporting ET_CONTROL_SRES Call by reference Type reference (TYPE) GRPC_T_API_CONTROL_SRES Process step search result 20091125
3 Importing IO_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20091030
4 Importing IV_CONTROL_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091029
5 Importing IV_ORGUNIT_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091029
6 Importing IV_PROCESS_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091029
7 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091029
8 Importing IV_REPORT_ID Call by reference Type reference (TYPE) GRFN_REPNAME Report name 20091125
9 Importing IV_SKIP_PROCESS_STEP Call by reference Type reference (TYPE) GRFN_BOOLEAN Boolean 20091029
10 Importing IV_SUBPROCESS_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091029
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20091029

Method SEARCH_BY_RULE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_CONTROL_RULES Call by reference Type reference (TYPE) GRPC_T_CTRLRLASGN Table type for Control Rule Assignment 20091201
2 Exporting ET_CONTROL_SRES Call by reference Type reference (TYPE) GRPC_T_API_CONTROL_SRES Process step search result 20091201
3 Importing IO_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20091112
4 Importing IV_AUTOMATED_ONLY Call by reference Type reference (TYPE) GRFN_BOOLEAN Boolean 20091112
5 Importing IV_CONTROL_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091112
6 Importing IV_EVENT_RULES_ONLY Call by reference Type reference (TYPE) GRFN_BOOLEAN Boolean 20091125
7 Importing IV_ORGUNIT_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091112
8 Importing IV_PROCESS_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091112
9 Importing IV_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID GRPC ID of the individual object 20091112
10 Importing IV_RULE_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091112
11 Importing IV_SKIP_SS_CONSUMER Call by reference Type reference (TYPE) GRFN_BOOLEAN Boolean 20091112
12 Importing IV_SUBPROCESS_SP Call by reference Type reference (TYPE) GRPC_API_SEARCH_PATTERN Search pattern for the Query APIs 20091112
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20091112

Method UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_CONTROL_BDATA_CHANGED Value transfer Type reference (TYPE) GRPC_S_API_CONTROL_BDATA Control data for API service - basic fields 20091022
2 Importing IS_CONTROL_CDATA_CHANGED Value transfer Type reference (TYPE) GRPC_S_API_CONTROL_CDATA Control data for API service - control fields 20091022
3 Importing IS_CONTROL_TDATA_CHANGED Value transfer Type reference (TYPE) GRPC_S_API_CONTROL_TDATA Control data for API service - testing fields 20091022
4 Importing IT_CONTROL_ACCGROUP Call by reference Type reference (TYPE) GRPC_T_API_CONTROL_ACCGROUP Account groups 20100818
5 Importing IT_CONTROL_REGULATION Call by reference Type reference (TYPE) GRFN_T_API_OBJECT_ID List of Regulations 20100106
6 Importing IT_CONTROL_RULE_CHANGED Call by reference Type reference (TYPE) GRPC_T_API_CONTROL_RULE Control Rule Assigment Linking Table 20091022
7 Importing IT_REGULATION_REQ Call by reference Type reference (TYPE) GRFN_T_API_REGULATION_REQ Regulation requirements 20091022
8 Importing IT_RELEVANCE Call by reference Type reference (TYPE) GRPC_T_API_CNTR_RELEVANCE control relevance list 20091022
9 Importing IT_RISK Call by reference Type reference (TYPE) GRPC_T_API_RISK_COVERAGE Table storing risks assigned to control 20091022
10 Importing IT_SUBGROUP Call by reference Type reference (TYPE) GRPC_T_API_CNTR_SUBGROUP Control Subgroup 20091022
11 Importing IV_REGULATION_ID Value transfer Type reference (TYPE) GRPC_API_OBJECT_ID GRPC ID of the individual object 20091022
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION 20091022
History
Last changed by/on SAP  20141106 
SAP Release Created in 600