SAP ABAP Class CL_GRPC_API_SERVICES (Service and helper class for ILD)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC-SPC (Application Component) Process Controls
     ⤷ GRPC_ENTITY_API (Package) GRC Process controls API

Properties

Class	CL_GRPC_API_SERVICES
Short Description	Service and helper class for ILD
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	GRPC_ENTITY_API	GRC Process controls API
Created	20070612	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	GRPCS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_GRPC_API_SERVICES has no interface implemented.

Friends

Class CL_GRPC_API_SERVICES has no friend class.

Attributes

Class CL_GRPC_API_SERVICES has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BAPIRET	Static method	Public	Method		20070612
2	BAPIRET_USER	Static method	Public	Method	Message contaning object id and user (locking failure)	20071114
3	CONVERT_EX_FN	Static method	Public	Method	Convert case exception to FN exception	20091103
4	CX_CASE	Static method	Public	Method	Convert case exception to et_message	20070702
5	CX_DOCUMENT	Static method	Public	Method	Convert case exception to et_message	20070929
6	ERROR	Static method	Public	Method		20070612
7	ERROR_FN	Static method	Public	Method		20080418
8	GET_CASE_REGULATION	Static method	Public	Method	Get regulation ID for case	20081203
9	GET_CONTROL_ID	Static method	Public	Method		20070727
10	GET_CONTROL_PROPOSAL	Static method	Public	Method		20081001
11	GET_DELEGATE	Static method	Public	Method		20070828
12	GET_ENTITY_ID	Static method	Public	Method		20071203
13	GET_ENTITY_TEXT	Static method	Public	Method		20071203
14	GET_EVENT_ID	Static method	Public	Method		20080526
15	GET_GUID	Static method	Public	Method		20070711
16	GET_JOBLOG_ID	Static method	Public	Method	OBSOLTE - Use CL_GRFN_API_IDENT=>GET_JOBLOG	20070925
17	GET_OBJECT_ID	Static method	Public	Method		20070612
18	GET_OBJID	Static method	Public	Method		20070613
19	GET_OLSP_NAME	Static method	Public	Method		20070820
20	GET_PC_OBJTYPE	Static method	Public	Method		20070917
21	GET_RULEVAR	Static method	Public	Method		20070815
22	GET_RULE_ID	Static method	Public	Method		20070706
23	GET_SCHEDULER_ID	Static method	Public	Method	Get Scheduler ID	20070925
24	GET_SCRIPT	Static method	Public	Method		20070905
25	GET_SDOK	Static method	Public	Method		20070712
26	GET_SEL_PRC	Static method	Public	Method		20070720
27	RAISE_EXCEPTION	Static method	Public	Method	Raise GRFN exception	20100402
28	TRANSLATE_ENTITY	Static method	Public	Method		20071203
29	WF_ERROR	Static method	Public	Method		20070612

Events

Class CL_GRPC_API_SERVICES has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	HRITEM_ID	Public	See coding			20070612
2	HRITEM_TXT	Public	See coding			20070612
3	S_HRITEM	Public	See coding			20070612
4	T_HRITEM	Public	See coding			20070612
5	T_USERNAME	Public	See coding			20070612

Method Signatures

Method BAPIRET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_MESSAGE	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070612
2	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	SY-MSGID	'GRPC_ENTITY_API'	Message Class	20070809
3	Importing	I_NO	Value transfer	☑	Type reference (TYPE)	SY-MSGNO		Message Number	20070612
4	Importing	I_TP	Value transfer	☐	Type reference (TYPE)	SY-MSGTY	'E'	Message Type	20070712
5	Importing	I_V1	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV1		20070612
6	Importing	I_V2	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV2		20070612
7	Importing	I_V3	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV3		20070612
8	Importing	I_V4	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV4		20070612

Method BAPIRET on class CL_GRPC_API_SERVICES has no exception.

Method BAPIRET_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_MESSAGE	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20071114
2	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	SY-MSGID	'GRPC_ENTITY_API'	Message Class	20071114
3	Importing	I_NO	Value transfer	☑	Type reference (TYPE)	SY-MSGNO		Message Number	20071114
4	Importing	I_OBJ_ID	Value transfer	☑	Type reference (TYPE)	ANY			20071114
5	Importing	I_OBJ_TXT	Value transfer	☑	Type reference (TYPE)	ANY			20071114
6	Importing	I_TP	Value transfer	☐	Type reference (TYPE)	SY-MSGTY	'E'	Message Type	20071114
7	Importing	I_USER	Value transfer	☑	Type reference (TYPE)	SYUNAME		User Name	20071114

Method BAPIRET_USER on class CL_GRPC_API_SERVICES has no exception.

Method CONVERT_EX_FN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IX_BAPI	Call by reference	☑	Object reference (TYPE REF TO)	CX_BAPI_EXCEPTION		Exception Basis Class for BAPI Migration	20091105
2	Importing	IX_CASE	Call by reference	☑	Object reference (TYPE REF TO)	CX_GRPC_CASE		PC: Case	20091103

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

Method CX_CASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_RESULT	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070702
2	Importing	I_EX	Value transfer	☐	Object reference (TYPE REF TO)	CX_GRPC_CASE		MIC: Case	20070702

Method CX_CASE on class CL_GRPC_API_SERVICES has no exception.

Method CX_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_RESULT	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070929
2	Importing	I_EX	Value transfer	☐	Object reference (TYPE REF TO)	CX_ROOT		MIC: Case	20070929

Method CX_DOCUMENT on class CL_GRPC_API_SERVICES has no exception.

Method ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NO	Value transfer	☑	Type reference (TYPE)	SY-MSGNO		Message Number	20070612
2	Importing	I_V1	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV1		20070612
3	Importing	I_V2	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV2		20070612
4	Importing	I_V3	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV3		20070612
5	Importing	I_V4	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV4		20070612

#	Exception	Resumable	Description	Created on
1	CX_BAPI_EXCEPTION	☐	Exception Basis Class for BAPI Migration	20070612

Method ERROR_FN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NO	Value transfer	☑	Type reference (TYPE)	SY-MSGNO		Message Number	20080418
2	Importing	I_V1	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV1		20080418
3	Importing	I_V2	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV2		20080418
4	Importing	I_V3	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV3		20080418
5	Importing	I_V4	Value transfer	☑	Type reference (TYPE)	ANY	SY-MSGV4		20080418

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Exception Basis Class for BAPI Migration	20080418

Method GET_CASE_REGULATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20081203
2	Importing	I_SESSION_ID	Call by reference	☐	Type reference (TYPE)	GRPC_API_SESSION_ID		GRPC unique session ID	20081209
3	Returning	R_REGULATION_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20081203

Method GET_CASE_REGULATION on class CL_GRPC_API_SERVICES has no exception.

Method GET_CONTROL_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CONTROL_ID	Value transfer	☐	Type reference (TYPE)	GRPCS_OBJECTID			20070727
2	Exporting	E_CONTROL_TYP	Value transfer	☐	Type reference (TYPE)	GRPCS_TYP			20070727
3	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070727

Method GET_CONTROL_ID on class CL_GRPC_API_SERVICES has no exception.

Method GET_CONTROL_PROPOSAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_SCRIPT		Script	20081001
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20081001

Method GET_CONTROL_PROPOSAL on class CL_GRPC_API_SERVICES has no exception.

Method GET_DELEGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_RESULT	Value transfer	☐	Type reference (TYPE)	GRPC_S_API_DELEGATE_LIST		The list of the delegations	20070828
2	Importing	I_OBJECT	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070828

Method GET_DELEGATE on class CL_GRPC_API_SERVICES has no exception.

Method GET_ENTITY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_API_ENTITY_ID		GRPC ID of the entity	20071203
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20071203

Method GET_ENTITY_ID on class CL_GRPC_API_SERVICES has no exception.

Method GET_ENTITY_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ENTITY_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_ENTITY_ID		GRPC ID of the individual object	20071203
2	Returning	R_ENTITY_TEXT	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_DESCR		GRPC ID of the entity	20071203

Method GET_ENTITY_TEXT on class CL_GRPC_API_SERVICES has no exception.

Method GET_EVENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_EVENT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_EVENT_ID		Event ID	20080526
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20080526

Method GET_EVENT_ID on class CL_GRPC_API_SERVICES has no exception.

Method GET_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GUID_32		GUID	20070711
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070711

Method GET_GUID on class CL_GRPC_API_SERVICES has no exception.

Method GET_JOBLOG_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_RESULT	Value transfer	☐	Type reference (TYPE)	GRPC_S_API_JOBLOG_ID		Job Log ID	20070929
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070925

Method GET_JOBLOG_ID on class CL_GRPC_API_SERVICES has no exception.

Method GET_OBJECT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070612
2	Importing	IS_DELEGATE	Value transfer	☑	Type reference (TYPE)	GRPC_S_API_DELEGATE_LIST		The list of the delegations	20070828
3	Importing	I_CONTROL_ID	Value transfer	☑	Type reference (TYPE)	GRPCS_OBJECTID			20070727
4	Importing	I_CONTROL_TYP	Value transfer	☑	Type reference (TYPE)	GRPCS_TYP			20070727
5	Importing	I_ENTITY	Value transfer	☐	Type reference (TYPE)	GRPC_API_ENTITY_ID		GRPC ID of the entity	20070612
6	Importing	I_EVENT	Value transfer	☑	Type reference (TYPE)	GRPC_EVENT_ID		Event ID	20080526
7	Importing	I_GUID	Value transfer	☑	Type reference (TYPE)	GUID_32		GUID in 'CHAR' Format in Uppercase	20070612
8	Importing	I_GUID_PROPOSAL	Value transfer	☑	Type reference (TYPE)	GUID_32		GUID in 'CHAR' Format in Uppercase	20081013
9	Importing	I_JOBSTEP	Value transfer	☑	Type reference (TYPE)	GRPC_JOBSTEP		Periodic Job in GRPC Scheduler	20070911
10	Importing	I_OBJID	Value transfer	☑	Type reference (TYPE)	OBJEKTID		Object ID	20070612
11	Importing	I_OLSP	Value transfer	☑	Type reference (TYPE)	GRPC_ORGUNITGRP		Ogranization Unit Group	20070820
12	Importing	I_RULE	Value transfer	☑	Type reference (TYPE)	GRPC_RLEID		Rule	20070718
13	Importing	I_RULEVAR	Value transfer	☑	Type reference (TYPE)	GRPC_RULEVAR		Rule Criteria	20070815
14	Importing	I_SCRIPT	Value transfer	☑	Type reference (TYPE)	GRPC_SCRIPT		Script	20070816
15	Importing	I_SDOK	Value transfer	☑	Type reference (TYPE)	SDOK_PRV_L		Attribute feature (long version)	20070712
16	Importing	I_SEL_PRC	Value transfer	☑	Type reference (TYPE)	GRPC_SEL_PRC_ID		Selection Procedure ID	20070720
17	Importing	I_USER	Value transfer	☑	Type reference (TYPE)	SY-UNAME		User Name	20071129

Method GET_OBJECT_ID on class CL_GRPC_API_SERVICES has no exception.

Method GET_OBJID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	OBJEKTID		Object ID	20070613
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070613

Method GET_OBJID on class CL_GRPC_API_SERVICES has no exception.

Method GET_OLSP_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_ORGUNITGRP		Ogranization Unit Group	20070820
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070820

Method GET_OLSP_NAME on class CL_GRPC_API_SERVICES has no exception.

Method GET_PC_OBJTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MIC_TYPE	Call by reference	☐	Type reference (TYPE)	GRPC_OBJTYPE		Object Type ID	20070917
2	Returning	R_PC_TYPE	Value transfer	☐	Type reference (TYPE)	GRPC_API_ENTITY_ID		GRPC ID of the entity	20070917

Method GET_PC_OBJTYPE on class CL_GRPC_API_SERVICES has no exception.

Method GET_RULEVAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_RULEVAR		Rule	20070815
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070815

Method GET_RULEVAR on class CL_GRPC_API_SERVICES has no exception.

Method GET_RULE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_RLEID		Rule	20070706
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070706

Method GET_RULE_ID on class CL_GRPC_API_SERVICES has no exception.

Method GET_SCHEDULER_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GUID_32		GUID in 'CHAR' Format in Uppercase	20070925
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070925

Method GET_SCHEDULER_ID on class CL_GRPC_API_SERVICES has no exception.

Method GET_SCRIPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_SCRIPT		Script	20070905
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070905

Method GET_SCRIPT on class CL_GRPC_API_SERVICES has no exception.

Method GET_SDOK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	SDOK_PRV_L		sdok id	20070712
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070712

Method GET_SDOK on class CL_GRPC_API_SERVICES has no exception.

Method GET_SEL_PRC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_SEL_PRC_ID			20070720
2	Importing	I_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20070720

Method GET_SEL_PRC on class CL_GRPC_API_SERVICES has no exception.

Method RAISE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☑	Object reference (TYPE REF TO)	IF_MESSAGE		Interface for Accessing Texts from Message Objects	20100402
2	Importing	IS_BAPIRET	Call by reference	☑	Type reference (TYPE)	BAPIRET2		Return Parameter	20100402
3	Importing	IT_REMOTE_MESSAGES	Call by reference	☑	Type reference (TYPE)	TSMESG		Message table message collector	20100402
4	Importing	IV_MSGCL	Call by reference	☐	Type reference (TYPE)	SY-MSGID		Message Class	20100402
5	Importing	IV_MSGNO	Call by reference	☐	Type reference (TYPE)	SY-MSGNO		Message Number	20100402
6	Importing	IV_MSGTY	Call by reference	☑	Type reference (TYPE)	SY-MSGTY		Message Type	20100402
7	Importing	IV_MSGV1	Call by reference	☑	Type reference (TYPE)	SY-MSGV1		Message Variable	20100402
8	Importing	IV_MSGV2	Call by reference	☑	Type reference (TYPE)	SY-MSGV2		Message Variable	20100402

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

Method TRANSLATE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ENTITY_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_ENTITY_ID		API Entity level	20071203
2	Returning	R_ENTITY_ID	Value transfer	☐	Type reference (TYPE)	GRPCS_OBJTYPE		MODEL_SETUP Entity level	20071203

Method TRANSLATE_ENTITY on class CL_GRPC_API_SERVICES has no exception.

Method WF_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_MESSAGE	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20070612
2	Importing	IT_MESSAGE	Value transfer	☐	Type reference (TYPE)	SWR_MSGTAB		Workflow Interfaces: Table for Messages	20070612

Method WF_ERROR on class CL_GRPC_API_SERVICES has no exception.

History

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