SAP ABAP Class CL_GRFN_SAPSCRIPT (SAPscript Persistence Layer)

Hierarchy

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

Properties

Class	CL_GRFN_SAPSCRIPT
Short Description	SAPscript Persistence Layer
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

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

Forward declarations

Class CL_GRFN_SAPSCRIPT has no forward declaration.

Interfaces

Class CL_GRFN_SAPSCRIPT has no interface implemented.

Friends

Class CL_GRFN_SAPSCRIPT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_APPLICATION_GRC	Constant	Public	☐	Type reference (TYPE)	TDOBJECT	'GRC'	Texts: application object	20110826
2	GC_APPLICATION_GRC_RM	Constant	Public	☐	Type reference (TYPE)	TDOBJECT	'GRC_RM'	Texts: application object	20110826
3	GC_CLASS_LONGTEXT	Constant	Public	☐	Type reference (TYPE)	TDID	'LTXT'	Long Text	20091008
4	GC_CLASS_NOTE	Constant	Public	☐	Type reference (TYPE)	TDID	'NOTE'	Notes History Text	20091008
5	GC_CLASS_PRIVATE_NOTE	Constant	Public	☐	Type reference (TYPE)	TDID	'PVTN'	Notes History Private Text	20131022
6	GC_TOKEN_LONGTEXT	Constant	Public	☐	Type reference (TYPE)	TOKEN	'LONG_TEXT'	Long Text	20091008
7	GC_TOKEN_SPM_ACT	Constant	Public	☐	Type reference (TYPE)	TOKEN	'SPM_ACT'	SPM log activity text	20091023
8	GC_TOKEN_SPM_ADNL	Constant	Public	☐	Type reference (TYPE)	TOKEN	'SPM_ADNL'	SPM log additional activity text	20091023
9	GC_TOKEN_SPM_RC	Constant	Public	☐	Type reference (TYPE)	TOKEN	'SPM_RC'	SPM log reason code text	20091023
10	MC_SAPSCRIPT_OBJECT	Constant	Private	☐	Type reference (TYPE)	TDOBJECT	'GRC'	Texts: application object	20121004

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONVERT_STRING_TO_TEXT_TABLE	Static method	Private	Method		20091008
2	CONVERT_TEXT_TABLE_TO_STRING	Static method	Private	Method		20091008
3	CREATE	Static method	Public	Method	Create a new text	20091008
4	DELETE	Static method	Public	Method	Delete a text	20091008
5	DELETE_ALL	Static method	Public	Method	Delete all texts for a given object ID	20091008
6	DELETE_WITH_ID	Static method	Private	Method		20091008
7	MODIFY	Static method	Public	Method	Creata a new text or update an existing text	20100111
8	QUERY	Static method	Public	Method	Retrieve all texts for a given object ID	20091008
9	RAISE_EXCEPTION	Static method	Private	Method		20091008
10	RETRIEVE	Static method	Public	Method	Retrieve a text	20091008
11	RETRIEVE_EN_STRING	Static method	Public	Method	Retrieve a text (only string)	20120416
12	RETRIEVE_STRING	Static method	Public	Method	Retrieve a text (only string)	20091015
13	RETRIEVE_WITH_ID	Static method	Private	Method		20091008
14	UPDATE	Static method	Public	Method	Update an existing text	20091008

Events

Class CL_GRFN_SAPSCRIPT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_TEXT	Public	See coding		Text	20091008	begin of S_TEXT, DATE type D, TIME type T, USER_ID type SYUNAME, TEXT type STRING, end of S_TEXT
2	TOKEN	Public	Type reference (TYPE)	CHAR15	Text Token	20091008
3	T_TEXT	Public	See coding		Text Table	20091008	T_TEXT type standard table of S_TEXT with non-unique default key

Method Signatures

Method CONVERT_STRING_TO_TEXT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20091008
2	Returning	RT_TEXT_TABLE	Value transfer	☐	Type reference (TYPE)	TEXT_LINE_TAB		Sub-table for structure TEXT_HEADERLINES	20091008

Method CONVERT_STRING_TO_TEXT_TABLE on class CL_GRFN_SAPSCRIPT has no exception.

Method CONVERT_TEXT_TABLE_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TEXT_TABLE	Call by reference	☐	Type reference (TYPE)	TEXT_LINE_TAB		Sub-table for structure TEXT_HEADERLINES	20091008
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20091008

Method CONVERT_TEXT_TABLE_TO_STRING on class CL_GRFN_SAPSCRIPT has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20091008
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20091008
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20091008
5	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20091008
6	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	TOKEN	GC_TOKEN_LONGTEXT	Text Token	20091008
7	Importing	IV_USER_ID	Call by reference	☑	Type reference (TYPE)	SYUNAME		User Name	20120307

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

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20091008
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20091008
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20091008
5	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	TOKEN	GC_TOKEN_LONGTEXT	Text Token	20091008

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

Method DELETE_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20091008
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20091008
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20091008

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

Method DELETE_WITH_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT		Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID		Text ID	20091008
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	TDOBNAME		Name	20091008
4	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU		Language Key of Current Text Environment	20091008

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

Method MODIFY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20100111
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20100111
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100111
5	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20100111
6	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	TOKEN	GC_TOKEN_LONGTEXT	Text Token	20100111

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

Method QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20091008
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20091008
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20091008
5	Importing	IV_USER_ID	Call by reference	☑	Type reference (TYPE)	SYUNAME		User Name	20131022
6	Returning	RT_TEXT	Value transfer	☐	Type reference (TYPE)	T_TEXT		Text Table	20091008

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

Method RAISE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSG_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20100111
2	Importing	IV_MSG_VAR1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20100111
3	Importing	IV_MSG_VAR2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20100111

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

Method RETRIEVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20091008
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20091008
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20091008
5	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	TOKEN	GC_TOKEN_LONGTEXT	Text Token	20091008
6	Returning	RS_TEXT	Value transfer	☐	Type reference (TYPE)	S_TEXT		Text	20091008

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

Method RETRIEVE_EN_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20120416
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20120416
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20120416
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20120416
5	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	TOKEN	GC_TOKEN_LONGTEXT	Text Token	20120416
6	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING		Text	20120416

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

Method RETRIEVE_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20091015
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20091015
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20091015
5	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	TOKEN	GC_TOKEN_LONGTEXT	Text Token	20091015
6	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING		Text	20091015

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

Method RETRIEVE_WITH_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT		Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID		Text ID	20091008
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	TDOBNAME		Name	20091008
4	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20091008
5	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	TOKEN	GC_TOKEN_LONGTEXT	Text Token	20121004
6	Returning	RS_TEXT	Value transfer	☐	Type reference (TYPE)	S_TEXT		Text	20091008

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

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	TDOBJECT	GC_APPLICATION_GRC	Texts: application object	20110826
2	Importing	IV_CLASS	Call by reference	☐	Type reference (TYPE)	TDID	GC_CLASS_LONGTEXT	Text ID	20091008
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20091008
4	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20091008
5	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20091008
6	Importing	IV_TOKEN	Call by reference	☐	Type reference (TYPE)	TOKEN	GC_TOKEN_LONGTEXT	Text Token	20091008

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

History

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