SAP ABAP Class CL_GRFN_SURVEY_UTILITY (Survey Utility class)

Hierarchy

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

Properties

Class	CL_GRFN_SURVEY_UTILITY
Short Description	Survey Utility class
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	GRFN_SURVEY	GRC Survey
Created	20100312	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GRFN_SURVEY_UTILITY has no forward declaration.

Interfaces

Class CL_GRFN_SURVEY_UTILITY has no interface implemented.

Friends

Class CL_GRFN_SURVEY_UTILITY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_ERRORS	Static Attribute	Private	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20100316

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_ADS	Static method	Public	Method	Check ADS connection	20100312
2	CONVERT_AMOUNT_INPUT	Static method	Public	Method	Convert the amount form CURRENCY bsed input	20120201
3	CONVERT_AMOUNT_OUTPUT	Static method	Public	Method	Convert the amount to be ready for WRITE TO CURRENCY	20100531
4	ERROR_PDF_GENERATION	Static method	Public	Method	Raise exception for pdf generation error	20100312
5	GET_AGENTSLOT	Static method	Public	Method	Return agentslot	20100409
6	GET_ANSWER_LIST	Static method	Public	Method	Return answer list	20100413
7	GET_COMM_SVYUI	Static method	Public	Method	Get common survey UI	20100407
8	GET_EMAIL_ADDRESS	Static method	Public	Method	Get email address of system user	20100331
9	GET_FORM_NAME	Static method	Public	Method	Get pdf form name	20100406
10	GET_MONITOR_DATA	Static method	Public	Method	According to taskplan ID to get monitor data	20100622
11	GET_OBJECT_TITLE	Static method	Public	Method	Return object title	20100325
12	GET_ONLINE_COMP	Static method	Public	Method	Get online survey component	20100520
13	GET_PA_SVYTMPLID	Static method	Public	Method	Return policy ackn survey template ID	20100524
14	GET_RECIPIENT_USER	Static method	Public	Method	Get recipient list	20100407
15	GET_SENDER_UNAME	Static method	Public	Method	Get the user name of sender	20100312
16	GET_SURVEY_CATEGORY	Static method	Public	Method	Return survey category	20100422
17	GET_SURVEY_DESC	Static method	Public	Method	Return survey descirbtion	20100720
18	GET_SURVEY_INST	Static method	Public	Method	Return survey instance	20100513
19	GET_SURVEY_QCATEGORY	Static method	Public	Method	Return survey question category	20100429
20	GET_SURVEY_STATUS	Static method	Public	Method	Return survey status(Offline: 'X')	20100422
21	GET_TASKPLAN_NAME	Static method	Public	Method	Get the name of taskplan	20100316
22	LOG_EXCEPTION	Static method	Public	Method		20100726
23	RAISE_EXCEPTION	Static method	Private	Method		20100629
24	SEND	Static method	Private	Method		20100629
25	SENDER_EXISTANCE_TRACK	Static method	Public	Method	Get sender email	20100409
26	SEND_SURVEY	Static method	Public	Method	Send survey	20100409
27	SET_USAGE_RIGHTS	Static method	Private	Method		20100702
28	_RAISE_ERROR	Static method	Public	Method	Raise Error	20100312
29	_RAISE_ERROR_BAPIRETTAB	Static method	Public	Method	Raise Error	20100316

Events

Class CL_GRFN_SURVEY_UTILITY has no event.

Types

Class CL_GRFN_SURVEY_UTILITY has no local type.

Method Signatures

Method CHECK_ADS Signature

Method CHECK_ADS on class CL_GRFN_SURVEY_UTILITY has no parameter.

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

Method CONVERT_AMOUNT_INPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_AMOUNT	Call by reference	☐	Type reference (TYPE)	DATA		Amount	20120201
2	Importing	IV_AMOUNT	Call by reference	☐	Type reference (TYPE)	DATA		Amount	20120201
3	Importing	IV_CURK	Call by reference	☐	Type reference (TYPE)	GRFN_CURRENCY		Currency	20120201

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

Method CONVERT_AMOUNT_OUTPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_AMOUNT	Call by reference	☐	Type reference (TYPE)	DATA		Amount	20100531
2	Importing	IV_AMOUNT	Call by reference	☐	Type reference (TYPE)	DATA		Amount	20100531
3	Importing	IV_CURK	Call by reference	☐	Type reference (TYPE)	GRFN_CURRENCY		Currency	20100531

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

Method ERROR_PDF_GENERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EX	Call by reference	☑	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20100312
2	Importing	IV_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20100312

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

Method GET_AGENTSLOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SVYTYP	Call by reference	☐	Type reference (TYPE)	GRFN_SURVEY_TYPE		Survey Type	20100409
2	Returning	RV_AGENTSLOT	Value transfer	☐	Type reference (TYPE)	GRFN_AGENTSLOT		Business Event	20100409

Method GET_AGENTSLOT on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_ANSWER_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_QUESTION	Call by reference	☐	Type reference (TYPE)	GRFN_S_SURVEY_QUESTION_ANSWER		Question with answer	20100414
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100413
3	Importing	IV_EDITABLE	Call by reference	☐	Type reference (TYPE)	BOOLEAN	'X'	Boolean Variable (X=True, -=False, Space=Unknown)	20100603

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

Method GET_COMM_SVYUI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SVYINST_UI	Call by reference	☐	Type reference (TYPE)	GRFN_S_SVYINST_UI		Survey Template UI	20100407
2	Exporting	ET_QUESTIONS	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_QUESTION_ANSWER		Question with answer	20100407
3	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100407
4	Importing	IS_SVYINST	Call by reference	☐	Type reference (TYPE)	GRFN_S_SVYINST		Survey Instance	20100407

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

Method GET_EMAIL_ADDRESS 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)	UNAME		User Name	20100331
2	Returning	RV_EMAIL	Value transfer	☐	Type reference (TYPE)	AD_SMTPADR		E-Mail Address	20100331

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

Method GET_FORM_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SVYTYPE	Call by reference	☐	Type reference (TYPE)	GRFN_SURVEY_TYPE			20100406
2	Returning	RV_FORM_NAME	Value transfer	☐	Type reference (TYPE)	FPNAME		Name of Form Object	20100406

Method GET_FORM_NAME on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_MONITOR_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKPLANID	Call by reference	☐	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20100622
2	Returning	RT_SVYINST	Value transfer	☐	Type reference (TYPE)	GRFN_T_SVYINST		Survey instance table	20100622

Method GET_MONITOR_DATA on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_OBJECT_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECTID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100325
2	Returning	RV_TITLE	Value transfer	☐	Type reference (TYPE)	STRING			20100325

Method GET_OBJECT_TITLE on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_ONLINE_COMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SVYTYPE	Call by reference	☐	Type reference (TYPE)	GRFN_SURVEY_TYPE		Survey Type	20100520
2	Returning	RV_ONLINE_COMP	Value transfer	☐	Type reference (TYPE)	WDY_COMPONENT_NAME		Web Dynpro: Component Name	20100520

Method GET_ONLINE_COMP on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_PA_SVYTMPLID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QCATEGORY	Call by reference	☐	Type reference (TYPE)	GRPC_QCATEGORY		Question category	20100524
2	Returning	RV_SVYTMPID	Value transfer	☐	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20100524

Method GET_PA_SVYTMPLID on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_RECIPIENT_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RECIPIENT_EMAIL	Call by reference	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_EMAIL		Recipients defined by e-mail-address	20100409
2	Exporting	ET_RECIPIENT_USER	Call by reference	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20100407
3	Importing	IV_AGENT_SLOT	Call by reference	☑	Type reference (TYPE)	GRFN_AGENTSLOT		Business Event	20100407
4	Importing	IV_OBJECTID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100407
5	Importing	IV_REGULATION_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100723
6	Importing	IV_TASKPLANID	Call by reference	☑	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20100407

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

Method GET_SENDER_UNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SENDER	Value transfer	☐	Type reference (TYPE)	UNAME		User Name	20100312

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

Method GET_SURVEY_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SVYTYP	Call by reference	☐	Type reference (TYPE)	GRFN_SURVEY_TYPE		Survey Type	20100422
2	Returning	RV_SVYCAT	Value transfer	☐	Type reference (TYPE)	GRFN_SURVEY_CAT		Survey Category	20100422

Method GET_SURVEY_CATEGORY on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_SURVEY_DESC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SVYTYPE	Call by reference	☐	Type reference (TYPE)	GRFN_SURVEY_TYPE		Survey Type	20100720
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	GRFN_TEXT100		Text	20100720

Method GET_SURVEY_DESC on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_SURVEY_INST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INSTID	Call by reference	☐	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20100513
2	Returning	RS_SVYINST	Value transfer	☐	Type reference (TYPE)	GRFN_S_SVYINST		Survey Type	20100513

Method GET_SURVEY_INST on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_SURVEY_QCATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SVYTYP	Call by reference	☐	Type reference (TYPE)	GRFN_SURVEY_TYPE		Survey Type	20100429
2	Returning	RV_QCATEGORY	Value transfer	☐	Type reference (TYPE)	GRPC_QCATEGORY		Question category	20100429

Method GET_SURVEY_QCATEGORY on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_SURVEY_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SVYTYP	Call by reference	☐	Type reference (TYPE)	GRFN_SURVEY_TYPE		Survey Type	20100422
2	Returning	RV_OFFLINE_ENABLE	Value transfer	☐	Type reference (TYPE)	GRFN_SURVEY_OFFLINE		Offline enable	20100422

Method GET_SURVEY_STATUS on class CL_GRFN_SURVEY_UTILITY has no exception.

Method GET_TASKPLAN_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKPLAN_GRP_ID	Call by reference	☑	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20100316
2	Importing	IV_TASKPLAN_ID	Call by reference	☑	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20100316
3	Returning	RV_TASKPLAN_NAME	Value transfer	☐	Type reference (TYPE)	GRFN_TEXT100		Text	20100316

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

Method LOG_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EX	Call by reference	☑	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20100726
2	Importing	IV_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20100726

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

Method RAISE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXCEPTION	Call by reference	☑	Object reference (TYPE REF TO)	CX_BCS		BCS: General Exceptions	20100629
2	Importing	IV_MSG_NO	Call by reference	☑	Type reference (TYPE)	SYMSGNO		Message Number	20100629
3	Importing	IV_MSG_VAR1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20100629
4	Importing	IV_MSG_VAR2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20100629

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

Method SEND 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	20100629
2	Importing	IT_RECIPIENT_EMAIL	Call by reference	☑	Type reference (TYPE)	GRFN_T_RECIPIENT_EMAIL		Recipients defined by e-mail-address	20100629
3	Importing	IT_RECIPIENT_USER	Call by reference	☑	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20100629
4	Importing	IT_VARIABLE	Call by reference	☑	Type reference (TYPE)	GRFN_T_MSG_VARIABLE		Variables used in notifications	20100629
5	Importing	IV_AGENTSLOT	Call by reference	☑	Type reference (TYPE)	GRFN_AGENTSLOT		Business Event	20100629
6	Importing	IV_ATTACHMENT_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20100629
7	Importing	IV_ATTACHMENT_TYPE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_TP		Code for document class	20100629
8	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20100629
9	Importing	IV_MESSAGE_CLASS	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20100629
10	Importing	IV_MESSAGE_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20100629
11	Importing	IV_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100629
12	Importing	IV_REGULATION_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100629
13	Importing	IV_SENDER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20100629
14	Importing	IV_SURVEY_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100629

Method SEND on class CL_GRFN_SURVEY_UTILITY has no exception.

Method SENDER_EXISTANCE_TRACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EMAIL	Value transfer	☐	Type reference (TYPE)	AD_SMTPADR		E-Mail Address	20100409

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

Method SEND_SURVEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SVYINST	Call by reference	☐	Type reference (TYPE)	GRFN_T_SVYINST		Survye table type	20100409
2	Importing	IV_NOTIFY	Call by reference	☑	Type reference (TYPE)	GRFN_BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20121012

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

Method SET_USAGE_RIGHTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_PDF	Call by reference	☐	Type reference (TYPE)	XSTRING			20100702
2	Importing	IT_URIGHT	Call by reference	☐	Type reference (TYPE)	TFPURIGHT		Table with Usage Rights	20100702

Method SET_USAGE_RIGHTS on class CL_GRFN_SURVEY_UTILITY has no exception.

Method _RAISE_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD	Call by reference	☑	Type reference (TYPE)	BAPI_FLD		Field in parameter	20100312
2	Importing	IV_NO	Call by reference	☑	Type reference (TYPE)	SY-MSGNO		Message Number	20100312
3	Importing	IV_PAR1	Call by reference	☑	Type reference (TYPE)	SY-MSGV1		Message Variable	20100312
4	Importing	IV_PAR2	Call by reference	☑	Type reference (TYPE)	SY-MSGV2		Message Variable	20100312

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

Method _RAISE_ERROR_BAPIRETTAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BAPIRETTAB	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20100316
2	Importing	IV_RAISE	Call by reference	☐	Type reference (TYPE)	BOOLEAN	'X'	Boolean Variable (X=True, -=False, Space=Unknown)	20100316

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

History

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