SAP ABAP Class CL_GRFN_UTIL_GENERAL (General utility methods)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_UTILITIES (Package) Various helping infrastructure for GRC ABAP

Properties

Class	CL_GRFN_UTIL_GENERAL
Short Description	General utility methods
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	GRFN_UTILITIES	Various helping infrastructure for GRC ABAP
Created	20080703	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	GRRM0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_GRFN_UTIL_GENERAL has no interface implemented.

Friends

Class CL_GRFN_UTIL_GENERAL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_MSGTYPE_ABORT	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'A'	Message Type	20120410
2	GC_MSGTYPE_ERROR	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'E'	Message Type	20120410
3	GC_MSGTYPE_INFO	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'I'	Message Type	20120410
4	GC_MSGTYPE_STATUS	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'S'	Message Type	20120410
5	GC_MSGTYPE_WARNING	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'W'	Message Type	20120410
6	MT_NAME_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	YT_NAME_BUFFER			20090407

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONVERT_FORMATTED_TEXT	Static method	Public	Method	Convert formatted text to plain text	20081120
2	CORRECT_VALIDITY	Static method	Public	Method	Correct validity according to its parent object	20081013
3	DE_ESCAPE	Static method	Public	Method	De escape HTML special characters	20110505
4	FORMAT_CURR_AMOUNT	Static method	Public	Method	Format an amount with currency into a string	20111205
5	GET_ALL_CHILDREN	Static method	Public	Method		20100706
6	GET_APP_FROM_REGULATION	Static method	Public	Method	Get Regulation from App Component	20100223
7	GET_BAPIRETTAB	Static method	Public	Method	Generate BAPIRETTAB from Message Class or Current SY message	20100128
8	GET_COUNTRY_REGION	Static method	Public	Method	Get country with and without region code	20130603
9	GET_COUNTRY_TEXT	Static method	Public	Method		20091023
10	GET_CURR_SMALLEST_UNIT	Static method	Public	Method	Gets the smallest unit for a currency, eg 0,01 for EUR	20120112
11	GET_DOMVALUE_TEXT	Static method	Public	Method	Get DDIC domain value text	20091201
12	GET_DTEL_TEXT	Static method	Public	Method	Get DDIC data element text	20100203
13	GET_HIERARCHY_TYPE	Static method	Public	Method		20081208
14	GET_LANGUAGE_TEXT	Static method	Public	Method		20091023
15	GET_MESSAGE_LONG_TEXT	Static method	Public	Method	Get Message Long Text	20100521
16	GET_NAME	Static method	Public	Method	Trys to get the name for an object	20080911
17	GET_NAME_FROM_SESSION	Static method	Public	Method	Trys to get the name for an object via session	20091201
18	GET_PARENT	Static method	Public	Method		20081208
19	GET_REGULATION_FROM_APP	Static method	Public	Method	Get App Component from Regulation	20100224
20	GET_SYSTEM_TZONE	Static method	Public	Method	Get system time zone	20100525
21	GET_TZONE_TEXT	Static method	Public	Method	Get time zone text	20100525
22	GUID_CREATE	Static method	Public	Method	Generate GUID	20100528
23	IS_VALID_CURRENCY	Static method	Public	Method	validate currency	20090206
24	NORMALIZE_PATTERN	Static method	Public	Method	Normalize the pattern	20080703
25	NOT_CLOSED	Static method	Public	Method	Is object locked by sign-off	20100719
26	NUMBER_TO_PRIOX	Static method	Public	Method	Convert number to priox	20081013
27	PREPROCESS_FORMATTED_TEXT	Static method	Private	Method	Remove all tags except lists and replace linebreaks	20121113
28	RAISE_EXCEPTION	Static method	Public	Method		20100430

Events

Class CL_GRFN_UTIL_GENERAL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_COUNTRY_REGION	Public	See coding			20130603	BEGIN OF ys_country_region, land1 TYPE grfn_orgunit_country, " Country Key landx TYPE grfn_title, " Country Name bland TYPE grfn_orgunit_region, " Region Key bezei TYPE grfn_title, " Region Name END OF ys_country_region
2	YT_COUNTRY_REGION	Public	See coding			20130603	yt_country_region TYPE TABLE OF ys_country_region

Method Signatures

Method CONVERT_FORMATTED_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COUNTER	Call by reference	☑	Type reference (TYPE)	I			20110505
2	Importing	IV_FORMATTED_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20081120
3	Importing	IV_LIST	Call by reference	☑	Type reference (TYPE)	STRING			20110505
4	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20081120

Method CONVERT_FORMATTED_TEXT on class CL_GRFN_UTIL_GENERAL has no exception.

Method CORRECT_VALIDITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_VALIDFROM	Value transfer	☐	Type reference (TYPE)	GRFN_BEGDA		Start Date	20081013
2	Changing	C_VALIDTO	Value transfer	☐	Type reference (TYPE)	GRFN_ENDDA		End Date	20081013
3	Importing	I_PARENT_VALIDFROM	Value transfer	☐	Type reference (TYPE)	GRFN_BEGDA		Start Date	20081013
4	Importing	I_PARENT_VALIDTO	Value transfer	☐	Type reference (TYPE)	GRFN_ENDDA		End Date	20081013

Method CORRECT_VALIDITY on class CL_GRFN_UTIL_GENERAL has no exception.

Method DE_ESCAPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20110505

Method DE_ESCAPE on class CL_GRFN_UTIL_GENERAL has no exception.

Method FORMAT_CURR_AMOUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AMOUNT	Call by reference	☐	Type reference (TYPE)	GRFN_AMOUNT		Amount	20111205
2	Importing	IV_CURRENCY	Call by reference	☐	Type reference (TYPE)	GRFN_CURRENCY		Currency	20111205
3	Returning	RV_FORMATTED	Value transfer	☐	Type reference (TYPE)	STRING			20111205

Method FORMAT_CURR_AMOUNT on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_ALL_CHILDREN 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	20120208
2	Importing	IV_JUMP_LOGIC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110105
3	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100706
4	Returning	RT_CHILDREN	Value transfer	☐	Type reference (TYPE)	GRFN_T_API_OBJECT_ID		Table type of API object ID	20100706

Method GET_ALL_CHILDREN on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_APP_FROM_REGULATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REGULATION_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100223
2	Returning	RV_APP	Value transfer	☐	Type reference (TYPE)	GRFN_APP_COMPONENT		Application Component	20100223

Method GET_APP_FROM_REGULATION on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_BAPIRETTAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSGCLASS	Call by reference	☐	Type reference (TYPE)	SY-MSGID	SY-MSGID	Message Class	20100128
2	Importing	IV_MSGNO	Call by reference	☐	Type reference (TYPE)	SY-MSGNO	SY-MSGNO	Message Number	20100128
3	Importing	IV_MSGTY	Call by reference	☐	Type reference (TYPE)	SY-MSGTY	'E'	Message Type	20100128
4	Importing	IV_V1	Call by reference	☐	Type reference (TYPE)	ANY	SY-MSGV1		20100128
5	Importing	IV_V2	Call by reference	☐	Type reference (TYPE)	ANY	SY-MSGV2		20100128
6	Importing	IV_V3	Call by reference	☐	Type reference (TYPE)	ANY	SY-MSGV3		20100128
7	Importing	IV_V4	Call by reference	☐	Type reference (TYPE)	ANY	SY-MSGV4		20100128
8	Returning	RT_RET	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20100128

Method GET_BAPIRETTAB on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_COUNTRY_REGION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RT_COUNTRY_REGION	Value transfer	☐	Type reference (TYPE)	YT_COUNTRY_REGION			20130603

Method GET_COUNTRY_REGION on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_COUNTRY_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COUNTRY	Value transfer	☐	Type reference (TYPE)	LAND		Country of company	20091023
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	GRFN_TITLE		Title/Short Name	20091023

Method GET_COUNTRY_TEXT on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_CURR_SMALLEST_UNIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENCY	Call by reference	☐	Type reference (TYPE)	GRFN_CURRENCY		Currency	20120112
2	Returning	RV_SMALLEST_UNIT	Value transfer	☐	Type reference (TYPE)	GRFN_AMOUNT		Amount	20120112

Method GET_CURR_SMALLEST_UNIT on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_DOMVALUE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOMNAME	Call by reference	☐	Type reference (TYPE)	DOMNAME		Domain name	20091201
2	Importing	IV_DOMVALUE	Call by reference	☐	Type reference (TYPE)	DOMVALUE_L		Values for Domains: Single Value / Upper Limit	20091201
3	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	VAL_TEXT		Short Text for Fixed Values	20091201

Method GET_DOMVALUE_TEXT on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_DTEL_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TEXT_HEADING	Call by reference	☐	Type reference (TYPE)	REPTEXT		Heading	20100203
2	Exporting	EV_TEXT_LONG	Call by reference	☐	Type reference (TYPE)	SCRTEXT_L		Long Field Label	20100203
3	Exporting	EV_TEXT_MEDIUM	Call by reference	☐	Type reference (TYPE)	SCRTEXT_M		Medium Field Label	20100203
4	Exporting	EV_TEXT_SHORT	Call by reference	☐	Type reference (TYPE)	SCRTEXT_S		Short Field Label	20100203
5	Importing	IV_DATAELEMENT	Call by reference	☐	Type reference (TYPE)	DDOBJNAME		Name of ABAP Dictionary Object	20100203

Method GET_DTEL_TEXT on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_HIERARCHY_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REGULATION_ID	Value transfer	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20081208
2	Returning	RV_HIERARCHY_TYPE	Value transfer	☐	Type reference (TYPE)	GRFN_ASSIGNMENT_TYPE		Assignment Type	20081208

Method GET_HIERARCHY_TYPE on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_LANGUAGE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Value transfer	☐	Type reference (TYPE)	LANGU		Language Key	20091023
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	GRFN_TITLE		Title/Short Name	20091023

Method GET_LANGUAGE_TEXT on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_MESSAGE_LONG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LONG_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Documentation text	20100521
2	Importing	IV_DOCU_ID	Value transfer	☑	Type reference (TYPE)	DOKHL-ID		Document class	20100521
3	Importing	IV_DOCU_OBJ	Value transfer	☐	Type reference (TYPE)	DOKHL-OBJECT		Documentation Object	20100521
4	Importing	IV_LANGU	Value transfer	☐	Type reference (TYPE)	SY-LANGU		Language Key of Current Text Environment	20100521

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

Method GET_NAME Signature

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

Method GET_NAME on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_NAME_FROM_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DESCR	Call by reference	☐	Type reference (TYPE)	STRING			20091210
2	Exporting	EV_IDENT	Call by reference	☐	Type reference (TYPE)	STRING			20091210
3	Exporting	EV_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20091210
4	Importing	IO_SESSION	Call by reference	☑	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20091201
5	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		ID of GRC session	20091201

Method GET_NAME_FROM_SESSION on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_PARENT 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	20081208
2	Importing	IV_OBJECT	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20081208
3	Importing	IV_ORGUNIT_VIEW	Call by reference	☑	Type reference (TYPE)	GRFN_ORG_VIEW_ID		Organization View ID	20100917
4	Importing	IV_REGULATION	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Required for Orgunit	20081208
5	Returning	RV_PARENT	Value transfer	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20081208

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

Method GET_REGULATION_FROM_APP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APP	Call by reference	☐	Type reference (TYPE)	GRFN_APP_COMPONENT			20100224
2	Returning	RV_REGULATION_ID	Value transfer	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID			20100224

Method GET_REGULATION_FROM_APP on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_SYSTEM_TZONE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SYS_TZONE	Value transfer	☐	Type reference (TYPE)	TZNZONE		Time Zone	20100525

Method GET_SYSTEM_TZONE on class CL_GRFN_UTIL_GENERAL has no exception.

Method GET_TZONE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20100525
2	Importing	IV_TZONE	Call by reference	☐	Type reference (TYPE)	TZNZONE		Time Zone	20100525
3	Returning	RV_TZONE_TEXT	Value transfer	☐	Type reference (TYPE)	TZNDESCTZN		Time Zone Text	20100525

Method GET_TZONE_TEXT on class CL_GRFN_UTIL_GENERAL has no exception.

Method GUID_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_GUID	Value transfer	☐	Type reference (TYPE)	GRFN_GUID		UUID of the GRC object (char32)	20100528

Method GUID_CREATE on class CL_GRFN_UTIL_GENERAL has no exception.

Method IS_VALID_CURRENCY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRENCY	Call by reference	☐	Type reference (TYPE)	GRFN_CURRENCY		Currency	20090206
2	Returning	RV_IS_VALID	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN		check ij currency is valid	20090206

Method IS_VALID_CURRENCY on class CL_GRFN_UTIL_GENERAL has no exception.

Method NORMALIZE_PATTERN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PATTERN	Call by reference	☐	Type reference (TYPE)	GRFN_API_SEARCH_PATTERN		API search pattern	20080703
2	Returning	RV_PATTERN	Value transfer	☐	Type reference (TYPE)	GRFN_API_SEARCH_PATTERN		Normalized pattern	20080703

Method NORMALIZE_PATTERN on class CL_GRFN_UTIL_GENERAL has no exception.

Method NOT_CLOSED 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	20100719
2	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100719
3	Importing	IV_ORGUNIT_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Orgunit ID for local object only	20100719
4	Importing	IV_ORGUNIT_VIEW	Call by reference	☑	Type reference (TYPE)	GRFN_ORG_VIEW_ID		Organization View ID	20100722
5	Importing	IV_REGULATION_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Regulation ID	20100719
6	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100719

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

Method NUMBER_TO_PRIOX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_PRIOX	Value transfer	☐	Type reference (TYPE)	GRFN_PRIOX		Priox	20081013
2	Importing	I_NUMBER	Value transfer	☐	Type reference (TYPE)	GRFN_NUMBER		number	20081013

Method NUMBER_TO_PRIOX on class CL_GRFN_UTIL_GENERAL has no exception.

Method PREPROCESS_FORMATTED_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20121113

Method PREPROCESS_FORMATTED_TEXT on class CL_GRFN_UTIL_GENERAL has no exception.

Method RAISE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MSG	Call by reference	☑	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20100525
2	Importing	IV_MSG_ID	Value transfer	☑	Type reference (TYPE)	SYMSGID		Message Class	20100430
3	Importing	IV_MSG_NO	Value transfer	☑	Type reference (TYPE)	SYMSGNO		Message Number	20100430
4	Importing	IV_MSG_TYPE	Value transfer	☐	Type reference (TYPE)	SYMSGTY	'E'	Message Type	20100430
5	Importing	IV_MSG_VAR1	Value transfer	☑	Type reference (TYPE)	SYMSGV		Message Variable	20100430
6	Importing	IV_MSG_VAR2	Value transfer	☑	Type reference (TYPE)	SYMSGV		Message Variable	20100430
7	Importing	IV_MSG_VAR3	Value transfer	☑	Type reference (TYPE)	SYMSGV		Message Variable	20100430
8	Importing	IV_MSG_VAR4	Value transfer	☑	Type reference (TYPE)	SYMSGV		Message Variable	20100430

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

History

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