SAP ABAP Interface IF_GRFN_API_POLICY (policy)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_POLICY (Package) GRC Policy Management

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_GRFN_API_POLICY	policy	20100108

Properties

Interface	IF_GRFN_API_POLICY
Short Description	policy

General Data

Package	GRFN_POLICY	GRC Policy Management
Created	20100107	SAP
Last changed	20141106
Unicode checks active	☑

Forward declarations

Interface IF_GRFN_API_POLICY has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_GRFN_API_BASIS	☐	☐	Basis interface for the GRC API	20100119

Friends

Interface IF_GRFN_API_POLICY has no friend.

Attributes

Interface IF_GRFN_API_POLICY has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CAN_LOCALIZE	Instance method	Public	Method	Check if the Policy can be localized	20100303
2	COPY	Static method	Public	Method		20100317
3	CREATE	Static method	Public	Method		20100107
4	CREATE_VERSION	Static method	Public	Method	Create new version	20100210
5	GET_ACTIVITY_LIST	Instance method	Public	Method	get all available activities for a policy	20100107
6	GET_LOCALIZE_INFO	Instance method	Public	Method	To get the localized policy ID and Orgunit ID	20100324
7	GET_REVW_APPR	Instance method	Public	Method	Get reviewer, approver, default approver and approval result	20100625
8	GET_STATUS	Instance method	Public	Method	get status of the policy	20100107
9	GET_USER_TYPE	Instance method	Public	Method		20100303
10	LOCALIZE	Static method	Public	Method		20100209
11	QUERY	Static method	Public	Method	query policy data	20100107
12	QUERY_IN_SCOPE	Static method	Public	Method	query policy data	20100129
13	QUERY_VERSIONS	Static method	Public	Method	query versions for a policy	20100107
14	RETRIEVE	Instance method	Public	Method		20100107
15	SET_ACTIVITY	Instance method	Public	Method	handle an action from user	20100107
16	UPDATE	Instance method	Public	Method		20100107

Events

Interface IF_GRFN_API_POLICY has no event.

Types

Interface IF_GRFN_API_POLICY has no local type.

Method Signatures

Method CAN_LOCALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ORGUNIT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100303
2	Returning	RV_CAN_LOCALIZE	Value transfer	☐	Type reference (TYPE)	GRFN_BOOLEAN		Boolean	20100303

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

Method COPY Signature

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

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

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_POLICY_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100107
2	Exporting	EV_POLICY_VER_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100107
3	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100107
4	Importing	IV_POLICY_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100208

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

Method CREATE_VERSION Signature

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

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

Method GET_ACTIVITY_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ACTIVITY	Call by reference	☐	Type reference (TYPE)	GRFN_T_ACTIVITY_FOR_STATUS		Texts for Business Transactions	20100107
2	Importing	IV_FROM_INBOX	Value transfer	☑	Type reference (TYPE)	GRFN_BOOLEAN		Indicator	20100929

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

Method GET_LOCALIZE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LOCALIZE	Call by reference	☐	Type reference (TYPE)	GRFN_BOOLEAN		Boolean	20100324
2	Exporting	EV_LOCALIZED_ORGUNIT	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100324
3	Exporting	EV_LOCALIZED_POLICY	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100324

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

Method GET_REVW_APPR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_APPROVER	Call by reference	☐	Type reference (TYPE)	SPERS_ULST		User names table	20100625
2	Exporting	ET_APPR_RSLT	Call by reference	☐	Type reference (TYPE)	GRFN_T_POLICY_APP_RESULT		Approval result	20100625
3	Exporting	ET_DEF_APPROVER	Call by reference	☐	Type reference (TYPE)	SPERS_ULST		User names table	20100709
4	Exporting	ET_DEF_APPR_INFO	Call by reference	☐	Type reference (TYPE)	GRFN_T_ROLE_LIST		New table of entity level roles	20100709
5	Exporting	ET_REVIEWER	Call by reference	☐	Type reference (TYPE)	SPERS_ULST		User names table	20100625
6	Importing	IT_PLC_SCOPE	Call by reference	☑	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		policy scope	20100709

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

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_STATUS	Value transfer	☐	Type reference (TYPE)	J_ISTAT		System status	20100122
2	Exporting	EV_STATUS_T	Value transfer	☐	Type reference (TYPE)	GRFN_POLICY_STATUS		Policy Status text	20100122

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

Method GET_USER_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_APPROVER	Value transfer	☐	Type reference (TYPE)	GRFN_BOOLEAN		Boolean	20100303
2	Exporting	EV_IS_OWNER	Value transfer	☐	Type reference (TYPE)	GRFN_BOOLEAN		Boolean	20100303
3	Exporting	EV_IS_REVIEWER	Value transfer	☐	Type reference (TYPE)	GRFN_BOOLEAN		Boolean	20100303

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

Method LOCALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_POLICY_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100209
2	Exporting	EV_POLICY_VER_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100209
3	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100209
4	Importing	IV_ORGUNIT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100209
5	Importing	IV_POLICY_VER_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100209

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

Method QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_POLICY	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_LIST		policy list	20100107
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100107
3	Importing	IV_SEARCH_PATTERN	Value transfer	☑	Type reference (TYPE)	GRFN_API_SEARCH_PATTERN		API search pattern	20100107

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

Method QUERY_IN_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_POLICY	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_IN_SCOPE		policy list	20100129
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100129
3	Importing	IV_SCOPE_OBJECT	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		API search pattern	20100129

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

Method QUERY_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_POLICY_VERSION	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_LIST		policy list	20100107
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100107
3	Importing	IV_IS_INCLUDE_VOID_VER	Call by reference	☐	Type reference (TYPE)	GRFN_BOOLEAN	'X'	Single-Character Flag	20120410
4	Importing	IV_POLICYVER_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100820
5	Importing	IV_POLICY_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100107

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

Method RETRIEVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_POLICY	Call by reference	☐	Type reference (TYPE)	GRFN_S_API_POLICY		policy data	20100107
2	Exporting	ET_ACTIVITY	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		Table type of API object ID	20100107
3	Exporting	ET_COMMENT	Call by reference	☐	Type reference (TYPE)	GRFN_T_POLICY_COMMENT		Policy comments	20100114
4	Exporting	ET_CONTROL	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		Table type of API object ID	20100107
5	Exporting	ET_DL	Call by reference	☐	Type reference (TYPE)	GRFN_T_POLICY_RECIPIENT		Policy Recipient Table	20120209
6	Exporting	ET_ECONTROL	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		Table type of API object ID	20100107
7	Exporting	ET_ORGUNIT	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		Table type of API object ID	20100107
8	Exporting	ET_PROCESS	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		Table type of API object ID	20100107
9	Exporting	ET_RISK	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		Table type of API object ID	20100107
10	Exporting	ET_ROLE	Call by reference	☐	Type reference (TYPE)	GRFN_T_POLICY_RECIPIENT		Policy Recipient Table	20100107
11	Exporting	ET_SOURCE	Call by reference	☐	Type reference (TYPE)	GRFN_T_POLICY_SOURCE		Policy Recipient Table	20100107
12	Exporting	ET_SUBPROCESS	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		Table type of API object ID	20100107
13	Exporting	ET_USER	Call by reference	☐	Type reference (TYPE)	GRFN_T_POLICY_RECIPIENT		User names table	20100107
14	Exporting	ET_USERGRP	Call by reference	☐	Type reference (TYPE)	GRFN_T_POLICY_RECIPIENT		Policy Recipient Table	20100107
15	Importing	IV_EDITABLE	Value transfer	☐	Type reference (TYPE)	GRFN_BOOLEAN	' '	Boolean	20100113

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

Method SET_ACTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTIVITY	Call by reference	☐	Type reference (TYPE)	J_VORGANG		Business Transaction	20100107

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

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_POLICY	Call by reference	☑	Type reference (TYPE)	GRFN_S_API_POLICY		policy data	20100107
2	Importing	IT_COMMENT	Call by reference	☑	Type reference (TYPE)	GRFN_T_POLICY_COMMENT		policy role	20100127
3	Importing	IT_RCPT	Call by reference	☑	Type reference (TYPE)	GRFN_T_POLICY_RECIPIENT		policy role	20100113
4	Importing	IT_SCOPE_OBJECT	Call by reference	☑	Type reference (TYPE)	GRFN_T_API_POLICY_SCOPE		Table type of API object ID	20100107
5	Importing	IT_SOURCE	Call by reference	☑	Type reference (TYPE)	GRFN_T_POLICY_SOURCE		policy role	20100107

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

History

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