SAP ABAP Class CL_GRFN_SURVEY_UTIL (Survey utility functions)

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_UTIL
Short Description	Survey utility functions
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

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

Forward declarations

Class CL_GRFN_SURVEY_UTIL has no forward declaration.

Interfaces

Class CL_GRFN_SURVEY_UTIL has no interface implemented.

Friends

Class CL_GRFN_SURVEY_UTIL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_HEADER_ACTIVE	Constant	Public	☐	Type reference (TYPE)	STRING	'ACTIVE'		20131205
2	C_HEADER_ANSWER_TYPE	Constant	Public	☐	Type reference (TYPE)	STRING	'ANSWER_TYPE'		20131205
3	C_HEADER_ATYPE	Constant	Public	☐	Type reference (TYPE)	STRING	'ATYPE'		20131205
4	C_HEADER_CATEGORY	Constant	Public	☐	Type reference (TYPE)	STRING	'CATEGORY'		20131205
5	C_HEADER_CHOICE	Constant	Public	☐	Type reference (TYPE)	STRING	'CHOICE'		20131205
6	C_HEADER_CHOICE_KEY	Constant	Public	☐	Type reference (TYPE)	STRING	'CHOICE_KEY'		20131205
7	C_HEADER_COMMENT_REQUIRED	Constant	Public	☐	Type reference (TYPE)	STRING	'COMMENT_REQUIRED'		20131205
8	C_HEADER_COMMENT_REQUIRED_OPT	Constant	Public	☐	Type reference (TYPE)	STRING	'COMMENT_REQUIRED_OPTION'		20131205
9	C_HEADER_DEPENDENT_QUESTION	Constant	Public	☐	Type reference (TYPE)	STRING	'DEPENDENT_QUESTION'		20131205
10	C_HEADER_DEPENDENT_QUESTION_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'DEPENDENT_QUESTION_ID'		20131205
11	C_HEADER_DESCRIPTION	Constant	Public	☐	Type reference (TYPE)	STRING	'DESCRIPTION'		20131205
12	C_HEADER_LIST_OF_CHOICES	Constant	Public	☐	Type reference (TYPE)	STRING	'LIST_OF_CHOICES'		20131205
13	C_HEADER_QEXPLAIN	Constant	Public	☐	Type reference (TYPE)	STRING	'QEXPLAIN'		20131205
14	C_HEADER_QUESTION	Constant	Public	☐	Type reference (TYPE)	STRING	'QUESTION'		20131205
15	C_HEADER_QUESTION_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'QUESTION_ID'		20131205
16	C_HEADER_QUESTION_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'QUESTION_NAME'		20131205
17	C_HEADER_SURVEY_CATEGORY	Constant	Public	☐	Type reference (TYPE)	STRING	'SURVEY_CATEGORY'		20131205
18	C_HEADER_SURVEY_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'SURVEY_ID'		20131205
19	C_HEADER_TEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'TEXT'		20131205
20	C_HEADER_TITLE	Constant	Public	☐	Type reference (TYPE)	STRING	'TITLE'		20131205
21	C_TAB_ANSWERTYPE	Constant	Public	☐	Type reference (TYPE)	STRING	'AnswerType'		20131205
22	C_TAB_MAPPING	Constant	Public	☐	Type reference (TYPE)	STRING	'Mapping'		20131205
23	C_TAB_QUESTIONS	Constant	Public	☐	Type reference (TYPE)	STRING	'Questions'		20131205
24	C_TAB_SURVEY	Constant	Public	☐	Type reference (TYPE)	STRING	'Survey'		20131205
25	MO_EXCEL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GRRM_UTIL_XLSX		Utility class for Handle XLSX	20131205
26	MO_READER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_FDT_XL_SPREADSHEET			20131202
27	MO_SESSION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20131203
28	MT_CHOICE	Instance attribute	Private	☐	Type reference (TYPE)	YT_CHOICE			20131202
29	MT_CHOICE_IMPACT_LEVEL	Static Attribute	Private	☐	Type reference (TYPE)	GRFN_T_SRV_QUESTION_CHOICE		Survey Question Choices	20131203
30	MT_CHOICE_PROB_LEVEL	Static Attribute	Private	☐	Type reference (TYPE)	GRFN_T_SRV_QUESTION_CHOICE		Survey Question Choices	20131203
31	MT_CHOICE_RATING	Static Attribute	Private	☐	Type reference (TYPE)	YT_RATING			20131203
32	MT_CHOICE_SPEED_OF_ONSET	Static Attribute	Private	☐	Type reference (TYPE)	GRFN_T_SRV_QUESTION_CHOICE		Survey Question Choices	20131203
33	MT_CHOICE_YES_NO	Static Attribute	Private	☐	Type reference (TYPE)	GRFN_T_SRV_QUESTION_CHOICE		Survey Question Choices	20131203
34	MT_COLLECTION	Instance attribute	Private	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20131204
35	MT_MAPPING	Instance attribute	Private	☐	Type reference (TYPE)	YT_MAPPING			20131202
36	MT_QCATEGORY	Instance attribute	Private	☐	Type reference (TYPE)	GRPC_T_API_QCATEGORY		Question category	20131203
37	MT_QUESTION	Instance attribute	Private	☐	Type reference (TYPE)	YT_QUESTION			20131202
38	MT_QUESTION_DATA	Instance attribute	Private	☐	Type reference (TYPE)	GRPC_T_API_SRV_QUESTION_DATA		Survey Question	20131205
39	MT_Q_MAPPING	Instance attribute	Private	☐	Type reference (TYPE)	YT_Q_MAPPING			20131204
40	MT_SURVEY	Instance attribute	Private	☐	Type reference (TYPE)	YT_SURVEY			20131202
41	MT_SURVEY_DATA	Instance attribute	Private	☐	Type reference (TYPE)	GRPC_T_API_SURVEY_DATA		Survey Template	20131205

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJ_CHOICE_KEY	Instance method	Private	Method		20131211
2	CHECK_CHOICES	Instance method	Private	Method		20131203
3	CHECK_MAPPING	Instance method	Private	Method		20131203
4	CHECK_QUESTIONS	Instance method	Private	Method		20131203
5	CHECK_SURVEYS	Instance method	Private	Method		20131203
6	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20131203
7	COLLECT_QUESTIONS	Instance method	Private	Method		20131205
8	CREATE_QUESTIONS	Instance method	Private	Method		20131203
9	CREATE_SURVEYS	Instance method	Private	Method		20131203
10	EXECUTE_QUESTION_DOWNLOAD	Instance method	Public	Method		20131205
11	EXECUTE_QUESTION_UPLOAD	Instance method	Public	Method		20131205
12	EXECUTE_SURVEY_DOWNLOAD	Instance method	Public	Method		20131205
13	EXECUTE_SURVEY_UPLOAD	Instance method	Public	Method		20131205
14	GET_KEY	Instance method	Private	Method		20131202
15	GET_SURVEY_QUESTIONS	Instance method	Private	Method		20131205
16	GET_TEXT	Instance method	Private	Method		20131202
17	OPEN_DOWNLOAD	Static method	Public	Method		20131205
18	OPEN_UPLOAD	Static method	Public	Method		20131202
19	READ_CHOICES	Instance method	Private	Method		20131202
20	READ_MAPPING	Instance method	Private	Method		20131202
21	READ_QUESTIONS	Instance method	Private	Method		20131202
22	READ_SURVEYS	Instance method	Private	Method		20131202
23	WRITE_MAPPING	Instance method	Private	Method		20131205
24	WRITE_QUESTIONS	Instance method	Private	Method		20131205
25	WRITE_SURVEYS	Instance method	Private	Method		20131205

Events

Class CL_GRFN_SURVEY_UTIL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_CHOICE	Private	See coding			20131202	begin of ys_choice, line type string, atype_ex type char20, atype type grpc_atype, rtype type grfn_rtype, choice_key type grfn_question_choice_key, choice_text type grfn_question_choice_text, end of ys_choice
2	YS_MAPPING	Private	See coding			20131202	begin of ys_mapping, line type string, survey_id type grfn_api_object_id, question_id type grfn_api_object_id, choice_key type char20, dependent_q_id type grfn_api_object_id, end of ys_mapping
3	YS_QUESTION	Private	See coding			20131202	begin of ys_question, line type string, question_id type grfn_api_object_id, qcategory type grpc_qcategory, atype_ex type char20, atype type grpc_atype, rtype type grfn_rtype, comment_required type string, text type grpc_qtext, qexplain type grfn_qexplain, link_q_id type grfn_api_object_id, end of ys_question
4	YS_Q_MAPPING	Private	See coding			20131204	begin of ys_q_mapping, line type string, survey_id type grfn_api_object_id, question_id type grfn_api_object_id, choice_key type grfn_question_choice_key, parent_q_id type grfn_api_object_id, end of ys_q_mapping
5	YS_RATING	Private	See coding			20131203	begin of ys_rating, rtype type grfn_rtype, comp type grfn_app_component, text type grpc_qtext, t_choice type grfn_t_srv_question_choice, end of ys_rating
6	YS_SURVEY	Private	See coding			20131202	begin of ys_survey, line type string, survey_id type grfn_api_object_id, isactive type grpc_isactive, qcategory type grpc_qcategory, text type grpc_stext, description type grpc_sdescription, end of ys_survey
7	YT_CHOICE	Private	See coding			20131202	yt_choice type table of ys_choice
8	YT_MAPPING	Private	See coding			20131202	yt_mapping type table of ys_mapping
9	YT_QUESTION	Private	See coding			20131202	yt_question type table of ys_question
10	YT_Q_MAPPING	Private	See coding			20131204	yt_q_mapping type table of ys_q_mapping
11	YT_RATING	Private	See coding			20131203	yt_rating type standard table of ys_rating with default key
12	YT_SURVEY	Private	See coding			20131202	yt_survey type table of ys_survey

Method Signatures

Method ADJ_CHOICE_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATYPE	Value transfer	☐	Type reference (TYPE)	GRPC_ATYPE		Answer Type	20131211
2	Importing	IV_CHOICE	Value transfer	☐	Type reference (TYPE)	STRING			20131211
3	Returning	RV_CHOICE	Value transfer	☐	Type reference (TYPE)	GRFN_QUESTION_CHOICE_KEY		Survey Question Choice Key	20131211

Method ADJ_CHOICE_KEY on class CL_GRFN_SURVEY_UTIL has no exception.

Method CHECK_CHOICES Signature

Method CHECK_CHOICES on class CL_GRFN_SURVEY_UTIL has no parameter.

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

Method CHECK_MAPPING Signature

Method CHECK_MAPPING on class CL_GRFN_SURVEY_UTIL has no parameter.

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

Method CHECK_QUESTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CREATE_ALL	Call by reference	☑	Type reference (TYPE)	AS4FLAG		Flag (X or Blank)	20131205

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

Method CHECK_SURVEYS Signature

Method CHECK_SURVEYS on class CL_GRFN_SURVEY_UTIL has no parameter.

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

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_GRFN_SURVEY_UTIL has no parameter.
Method CLASS_CONSTRUCTOR on class CL_GRFN_SURVEY_UTIL has no exception.

Method COLLECT_QUESTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARENT_Q_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20131205
2	Importing	IV_SURVEY_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20131205
3	Returning	RV_CYCLE_FOUND	Value transfer	☐	Type reference (TYPE)	AS4FLAG		Flag (X or Blank)	20131205

Method COLLECT_QUESTIONS on class CL_GRFN_SURVEY_UTIL has no exception.

Method CREATE_QUESTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	I			20131206

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

Method CREATE_SURVEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	I			20131206

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

Method EXECUTE_QUESTION_DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_EXCEL	Call by reference	☐	Type reference (TYPE)	XSTRING			20131205
2	Importing	IT_QUESTION	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20131205

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

Method EXECUTE_QUESTION_UPLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	I			20131206

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

Method EXECUTE_SURVEY_DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_EXCEL	Call by reference	☐	Type reference (TYPE)	XSTRING			20131205
2	Importing	IT_SURVEY	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20131205

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

Method EXECUTE_SURVEY_UPLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	I			20131206

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

Method GET_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ANY			20131202
2	Returning	RV_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20131202

Method GET_KEY on class CL_GRFN_SURVEY_UTIL has no exception.

Method GET_SURVEY_QUESTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SURVEY	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20131205
2	Returning	RT_QUESTION	Value transfer	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20131205

Method GET_SURVEY_QUESTIONS on class CL_GRFN_SURVEY_UTIL has no exception.

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ANY			20131202
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20131202

Method GET_TEXT on class CL_GRFN_SURVEY_UTIL has no exception.

Method OPEN_DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_GRFN_SURVEY_UTIL		Survey utility functions	20131205

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

Method OPEN_UPLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING			20131202
2	Importing	IV_FILE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20131202
3	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_GRFN_SURVEY_UTIL		Survey utility functions	20131202

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

Method READ_CHOICES Signature

Method READ_CHOICES on class CL_GRFN_SURVEY_UTIL has no parameter.

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

Method READ_MAPPING Signature

Method READ_MAPPING on class CL_GRFN_SURVEY_UTIL has no parameter.

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

Method READ_QUESTIONS Signature

Method READ_QUESTIONS on class CL_GRFN_SURVEY_UTIL has no parameter.

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

Method READ_SURVEYS Signature

Method READ_SURVEYS on class CL_GRFN_SURVEY_UTIL has no parameter.

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

Method WRITE_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SURVEY	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20131205

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

Method WRITE_QUESTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUESTION	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20131205

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

Method WRITE_SURVEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SURVEY	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20131205

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

History

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