SAP ABAP Class CL_GRFN_API_AP (Audit Plan Proposal 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	20110718
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_API_AP	Audit Plan	20110718
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_API_ROLE_CONTAINER	API role container	20110718

Properties

Class	CL_GRFN_API_AP
Short Description	Audit Plan Proposal 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	20110718	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GRFN_API_AP has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_GRFN_API_AP	☐	☐	Audit Plan	20110718
2	IF_GRFN_API_ROLE_CONTAINER	☐	☐	API role container	20110718

Friends

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

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_AO_ID_LENGTH	Constant	Private	☐	Type reference (TYPE)	INT4	'40'	Natural number	20110718
2	GC_AP_CLASS_DESC	Constant	Private	☐	Type reference (TYPE)	TDID	'APV1'	Text ID	20110718
3	MC_ERROR	Constant	Private	☐	Type reference (TYPE)	SY-MSGTY	'E'	Message Type	20110718
4	MC_MESSAGE_CLASS	Constant	Private	☐	Type reference (TYPE)	SY-MSGID	'GRFN_ENTITY_API'	Message Class	20110718
5	MC_MODEL_CLASS	Constant	Private	☐	Type reference (TYPE)	CLASSNAME	'CL_GRFN_MODEL_AP'	Reference type	20110718
6	MC_WD_MESSAGE_CLASS	Constant	Private	☐	Type reference (TYPE)	SY-MSGID	'GRFN_WD'	Message Class	20110718

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_AUDIT_USER	Instance method	Public	Method		20111028
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110718
3	GET	Static method	Private	Method	Create API instance	20110718
4	GET_LONG_TEXT	Static method	Public	Method	Get Audit Entity Description Text	20110718
5	MODIFY_AUDIT_PLAN	Instance method	Public	Method	Transfer data to Audit Plan	20110801
6	RAISE_ERROR	Static method	Public	Method		20110916
7	SET_LONG_TEXT	Static method	Public	Method	Set Audit Entity Description Text	20110718
8	TRANSPORT_AUDIT_PLAN	Static method	Public	Method	Transfer Audit Plan Proposal	20110908

Events

Class CL_GRFN_API_AP has no event.

Types

Class CL_GRFN_API_AP has no local type.

Method Signatures

Method CHECK_AUDIT_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UNAME	Call by reference	☐	Type reference (TYPE)	SY-UNAME		User Name	20111028
2	Returning	RV_AUDIT_USER	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20111028

Method CHECK_AUDIT_USER on class CL_GRFN_API_AP has no exception.

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	20110718
2	Importing	IV_OBJECT	Value transfer	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110718

Method CONSTRUCTOR on class CL_GRFN_API_AP 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	20110718
2	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110718
3	Returning	RO_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GRFN_API_AP		Audit Plan API	20110718

Method GET on class CL_GRFN_API_AP has no exception.

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	20110718
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20110718
3	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	GRFN_TEXT		UUID of the GRC object (char32)	20110718

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

Method MODIFY_AUDIT_PLAN 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	20110801
2	Importing	IS_AP	Call by reference	☐	Type reference (TYPE)	GRFN_S_API_AP		Auditable Enity API structure	20110801
3	Importing	IT_AO	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20110801
4	Importing	IV_ACTION	Call by reference	☐	Type reference (TYPE)	J_VORGANG		Business Transaction	20110801

Method MODIFY_AUDIT_PLAN on class CL_GRFN_API_AP has no exception.

Method RAISE_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NO	Call by reference	☐	Type reference (TYPE)	SY-MSGNO		Message Number	20110916
2	Importing	PAR1	Call by reference	☑	Type reference (TYPE)	SY-MSGV1		Message Variable	20110916
3	Importing	PAR2	Call by reference	☑	Type reference (TYPE)	SY-MSGV2		Message Variable	20110916
4	Importing	PAR3	Call by reference	☑	Type reference (TYPE)	SY-MSGV3		Message Variable	20110916
5	Importing	PAR4	Call by reference	☑	Type reference (TYPE)	SY-MSGV4		Message Variable	20110916
6	Returning	RT_MESSAGE	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20110916

Method RAISE_ERROR on class CL_GRFN_API_AP has no exception.

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	20110718
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20110718
3	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	GRFN_TEXT		String	20110718

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

Method TRANSPORT_AUDIT_PLAN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_AP	Call by reference	☐	Type reference (TYPE)	GRFN_S_API_AP		Auditable Enity API structure	20110908

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

History

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