SAP ABAP Interface IF_GRFN_API_BRA (Business Rule Assignment API, used by BRAsgmt module)

Hierarchy

☛ 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_BRA	Business Rule Assignment API	20100305

Properties

Interface	IF_GRFN_API_BRA
Short Description	Business Rule Assignment API, used by BRAsgmt module

General Data

Package	GRFN_ENTITY_API	GRC Foundation API
Created	20100305	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	Abstract	Final	Description	Created on
1	IF_GRFN_API_BASIS	☐	☐	Basis interface for the GRC API	20100305

Friends

Interface IF_GRFN_API_BRA has no friend.

Attributes

Interface IF_GRFN_API_BRA has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONTROL_ADD	Instance method	Public	Method	(control) Add BRs to one object	20100412
2	CONTROL_DELETE	Instance method	Public	Method	(control) Delete BRs to one object	20100318
3	CONTROL_IS_VALID_MODIFY	Static method	Public	Method	(control)check if the control is valid to be modified	20110217
4	CONTROL_RETRIEVE_COMMON	Instance method	Public	Method	(control) Get common assigned BRs information object	20100318
5	CONTROL_RETRIEVE_REG_SPECIFIC	Instance method	Public	Method	(control) Get reg-spec assigned BRs information for object	20100318
6	CONTROL_UPDATE_COMMON	Instance method	Public	Method	(control) maintain common assigned BR frequency	20100409
7	CONTROL_UPDATE_REG_SPECIFIC	Instance method	Public	Method	(control) maintain reg-spec assigned BR frequency, common X	20100409
8	LOCK	Instance method	Public	Method	Lock the BRA instance	20100407
9	QUERY	Static method	Public	Method	Get the BRA ID for an assignment object: control or risk	20100318
10	RISK_ADD	Instance method	Public	Method	(risk) Add BRs to one object	20100318
11	RISK_DELETE	Instance method	Public	Method	(risk) Delete BRs to one object	20100318
12	RISK_RETRIEVE	Instance method	Public	Method	(risk) Get assigned BRs information for the object	20100318
13	SEARCH_BY_BR	Static method	Public	Method	Search assigned control/risk for certain business rules	20100723

Events

Interface IF_GRFN_API_BRA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_BRA_RULE_BASE	Public	See coding		Business Rule Assignment Rule Base Structure	20100318	BEGIN OF ys_bra_rule_base, bra_id TYPE grfn_api_object_id, " BRA/[GUID] entity TYPE grfn_api_entity_id, " Reference Object Entity: CONTROL / RISK objid TYPE grfn_api_object_id, " Reference Object ID: Local Control/Risk ID br_id TYPE grfn_api_object_id, " BR/50001234 brname TYPE grfn_brname, brdesc TYPE grfn_brdesc, valid_from TYPE begdatum, " BRA Valid From - For control, this attribute is empty valid_to TYPE enddatum, " BRA Valid To - For control, this attribute is empty END OF ys_bra_rule_base
2	YS_BRA_RULE_CTL	Public	See coding		Business Rule Assignment Rule Control Structure	20100318	BEGIN OF ys_bra_rule_ctl. INCLUDE TYPE ys_bra_rule_base. TYPES ctl_trigger TYPE grfn_control_trigger. " Control Trigger: Date or Event TYPES is_common TYPE grfn_xfeld. " Used for Common or not TYPES regulation_id TYPE grfn_api_object_id. " Regulation ID TYPES frequency TYPE grfn_tf_frequency. " Frequency ID TYPES frequency_text TYPE grfn_tf_text. TYPES monitoring TYPE grfn_xfeld. " Monitoring Flag, for Scheduler TYPES compliance TYPE grfn_xfeld. " Compliance Flag, for Planner TYPES END OF ys_bra_rule_ctl
3	YS_BRA_RULE_CTL_DETAIL	Public	See coding		Business Rule Assignment Rule Control - Detail Structure	20100319	BEGIN OF ys_bra_rule_ctl_detail. INCLUDE TYPE ys_bra_rule_ctl. TYPES bra_item_guid TYPE grfn_guid. TYPES detail_valid_from TYPE begdatum. TYPES detail_valid_to TYPE enddatum. TYPES END OF ys_bra_rule_ctl_detail
4	YS_BRA_RULE_RISK	Public	See coding		Business Rule Assignment Rule Risk Structure	20100318	BEGIN OF ys_bra_rule_risk. INCLUDE TYPE ys_bra_rule_base. TYPES END OF ys_bra_rule_risk
5	YT_BRA_RULE_BASE	Public	See coding		Business Rule Assignment Rule Base Table	20100319	yt_bra_rule_base TYPE STANDARD TABLE OF ys_bra_rule_base
6	YT_BRA_RULE_CTL	Public	See coding		Business Rule Assignment Rule Control Table	20100318	yt_bra_rule_ctl TYPE STANDARD TABLE OF ys_bra_rule_ctl
7	YT_BRA_RULE_CTL_DETAIL	Public	See coding		Business Rule Assignment Rule Control - Detail Table	20100319	yt_bra_rule_ctl_detail TYPE STANDARD TABLE OF ys_bra_rule_ctl_detail
8	YT_BRA_RULE_RISK	Public	See coding		Business Rule Assignment Rule Risk Table	20100318	yt_bra_rule_risk TYPE STANDARD TABLE OF ys_bra_rule_risk

Method Signatures

Method CONTROL_ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BR	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		BR Object IDs which will be added	20100412
2	Importing	IV_COMMON	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		flag to indicate if add to common	20100412
3	Importing	IV_REGULATION	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		if not add to common, add to which regulation	20100412

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100412

Method CONTROL_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BRA_RULE_CTL	Call by reference	☐	Type reference (TYPE)	YS_BRA_RULE_CTL		Business Rule Assignment Rule Control Structure	20100318

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100318

Method CONTROL_IS_VALID_MODIFY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20110217
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20110217
3	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110217

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110217

Method CONTROL_RETRIEVE_COMMON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BRA_RULE_CTL	Call by reference	☐	Type reference (TYPE)	YT_BRA_RULE_CTL		Business Rule Assignment Rule Risk Table	20100318
2	Exporting	ET_BRA_RULE_CTL_DETAIL	Call by reference	☐	Type reference (TYPE)	YT_BRA_RULE_CTL_DETAIL		Business Rule Assignment Rule Control - Detail Table	20100319

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100318

Method CONTROL_RETRIEVE_REG_SPECIFIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BRA_RULE_CTL	Call by reference	☐	Type reference (TYPE)	YT_BRA_RULE_CTL		Business Rule Assignment Rule Risk Table	20100318
2	Exporting	ET_BRA_RULE_CTL_DETAIL	Call by reference	☐	Type reference (TYPE)	YT_BRA_RULE_CTL_DETAIL		Business Rule Assignment Rule Control - Detail Table	20100319
3	Exporting	EV_USE_COMMON	Call by reference	☐	Type reference (TYPE)	GRFN_BRASGMT_USECOMMON		Use Common or Regulation-Specific BRs	20100419
4	Importing	IV_REGULATION_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100319

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100412

Method CONTROL_UPDATE_COMMON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BRA_RULE_CTL	Call by reference	☐	Type reference (TYPE)	YT_BRA_RULE_CTL		Business Rule Assignment Rule Control Table	20100409

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100409

Method CONTROL_UPDATE_REG_SPECIFIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BRA_RULE_CTL	Call by reference	☑	Type reference (TYPE)	YT_BRA_RULE_CTL		Business Rule Assignment Rule Control Table	20100409
2	Importing	IV_REGULATION_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Regulation API Object ID	20100420
3	Importing	IV_USE_COMMON	Call by reference	☐	Type reference (TYPE)	GRFN_BRASGMT_USECOMMON		Use Common or Regulation-Specific BRs	20100420

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100409

Method LOCK Signature

Method LOCK on Interface IF_GRFN_API_BRA has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100408

Method QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		BRA Object ID	20100318
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100318
3	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID: Control/Risk	20100318

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100318

Method RISK_ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BR	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		BR Object IDs which will be added	20100412

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100318

Method RISK_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BRA_RULE_RISK	Call by reference	☐	Type reference (TYPE)	YS_BRA_RULE_RISK		Business Rule Assignment Rule Risk Structure	20100318

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100318

Method RISK_RETRIEVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BRA_RULE_RISK	Call by reference	☐	Type reference (TYPE)	YT_BRA_RULE_RISK		Business Rule Assignment Rule Risk Table	20100318

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100318

Method SEARCH_BY_BR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID			20100723
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100723
3	Importing	IT_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Control or Risk API Object table	20100723
4	Importing	IV_BR_NAME	Call by reference	☐	Type reference (TYPE)	GRFN_API_SEARCH_PATTERN		BR Name	20100723
5	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	GRFN_API_ENTITY_ID		Control or Risk	20100723

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20100723

History

Last changed by/on	SAP	20141106
SAP Release Created in	600