SAP ABAP Class CL_GRFN_API_AE (Auditable Entity API)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_ENTITY_API (Package) GRC Foundation API

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GRFN_API_BASIS	Basis class for GRC API classes	20110531
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_API_AE	Auditable Entity	20110531
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_API_MD_COMMON	Interface for common master data	20110608
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_API_ROLE_CONTAINER	API role container	20110608

Properties

Class	CL_GRFN_API_AE
Short Description	Auditable Entity API
Super Class	CL_GRFN_API_BASIS	Basis class for GRC API classes
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	GRFN_ENTITY_API	GRC Foundation API
Created	20110531	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GRFN_API_AE has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_GRFN_API_AE	☐	☐	Auditable Entity	20110531
2	IF_GRFN_API_MD_COMMON	☐	☐	Interface for common master data	20110608
3	IF_GRFN_API_ROLE_CONTAINER	☐	☐	API role container	20110608

Friends

#	Friend	Modeled only	Created on	Description
1	CL_GRFN_API_SESSION	☐	20110531	Session Management for GRC APIs

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_AE_CLASS_DESC	Constant	Private	☐	Type reference (TYPE)	TDID	'AEV1'	Text ID	20110608
2	GC_AO_ID_LENGTH	Constant	Private	☐	Type reference (TYPE)	INT4	'40'	Natural number	20110613
3	MC_ERROR	Constant	Private	☐	Type reference (TYPE)	SY-MSGTY	'E'	Message Type	20110531
4	MC_MESSAGE_CLASS	Constant	Private	☐	Type reference (TYPE)	SY-MSGID	'GRFN_ENTITY_API'	Message Class	20110531
5	MC_MODEL_CLASS	Constant	Private	☐	Type reference (TYPE)	CLASSNAME	'CL_GRFN_MODEL_AUDIT'	Reference type	20110531
6	MC_WD_MESSAGE_CLASS	Constant	Private	☐	Type reference (TYPE)	SY-MSGID	'GRFN_WD'	Message Class	20110531
7	MV_SUBPROCESS	Instance attribute	Private	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110913

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110531
2	GET	Static method	Private	Method	Create API instance	20110531
3	GET_AE_FROM_RISK	Static method	Public	Method	Retrieve Risk Related Auditable Entity	20111014
4	GET_AE_OBJS_DESC	Instance method	Public	Method	Get the related objects description	20111208
5	GET_LONG_TEXT	Static method	Public	Method	Get Audit Entity Description Text	20110608
6	SET_LONG_TEXT	Static method	Public	Method	Set Audit Entity Description Text	20110608

Events

Class CL_GRFN_API_AE has no event.

Types

Class CL_GRFN_API_AE has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20110531
2	Importing	IV_OBJECT	Value transfer	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110531

Method CONSTRUCTOR on class CL_GRFN_API_AE has no exception.

Method GET 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	20110531
2	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110531
3	Returning	RO_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GRFN_API_AE		Auditable Entity API	20110531

Method GET on class CL_GRFN_API_AE has no exception.

Method GET_AE_FROM_RISK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RISK_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20111014
2	Returning	RT_RISK_AE	Value transfer	☐	Type reference (TYPE)	GRFN_T_AEOBJ		Objects assigned to Audit Entity	20111014

Method GET_AE_FROM_RISK on class CL_GRFN_API_AE has no exception.

Method GET_AE_OBJS_DESC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RELOBJ	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_AE_RELOBJ		Table of auditable entity related objects API	20111208
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20111208
3	Importing	IT_RELOBJ	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_AE_RELOBJ		Table of auditable entity related objects API	20111208

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

Method GET_LONG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID		String	20110608
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20110608
3	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	GRFN_TEXT		UUID of the GRC object (char32)	20110608

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

Method SET_LONG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLASS	Call by reference	☑	Type reference (TYPE)	TDID		Text ID	20110608
2	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20110608
3	Importing	IV_TEXT	Call by reference	☑	Type reference (TYPE)	GRFN_TEXT		String	20110608

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

History

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