SAP ABAP Class CL_RCC_COMMOBJECT (Communication Object RCCF vs Engine)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-RCC (Application Component) Remote Control and Communication Framework
     ⤷ RCC_COM (Package) RCCF: Communication

Properties

Class	CL_RCC_COMMOBJECT
Short Description	Communication Object RCCF vs Engine
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RCC_COM	RCCF: Communication
Created	20080320	SAP
Last change	20110908	SAP
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	THFB	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RCC_COMMOBJECT has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	IF_RCC_ENGINE	☐	20080320	RCCF Engine Interface

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_COMMOBJ	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_RCC_COMMOBJECT=>		Interface for Communication Interface Objects	20080320
2	MT_CALLBACKS	Static Attribute	Private	☐	Type reference (TYPE)	LTYT_CALLBACKS			20080320

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DATA	Static method	Private	Method	Daten setzen	20080320
2	ADD_EXTRA_PARAMETER	Static method	Public	Method	Edit Extrainfos	20080320
3	ADD_EXTRA_PARAMETER_INT	Static method	Private	Method	Internal: Edit Extrainfos	20080320
4	ADD_FINISH	Static method	Public	Method	Set End Result	20080320
5	ADD_FINISH_INT	Static method	Private	Method	Endergebnis setzen	20080320
6	ADD_MESSAGE	Static method	Public	Method	New Messages	20080320
7	ADD_MESSAGE_INT	Static method	Private	Method	Neue Meldungen	20080320
8	ADD_PROGRESS	Static method	Public	Method	New Status Information	20080320
9	ADD_PROGRESS_INT	Static method	Private	Method	Neue Statusinformationen	20080320
10	ADD_RESULT	Static method	Public	Method	New Result Information	20080320
11	ADD_RESULT_INT	Static method	Private	Method	Neue Ergebnisinformationen	20080320
12	ATTACH	Static method	Public	Method	Register Engine	20080320
13	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20080320
14	DETACH	Static method	Public	Method	Cancel Engine Registration	20080320
15	FORCE_CLEAN	Static method	Public	Method	Release	20080320
16	FREE	Static method	Public	Method	Release Used Data	20080320
17	GET_DATA	Static method	Public	Method	Get data	20080320
18	IS_ENGINE_TASK_ALIVE	Static method	Public	Method	Checks If Engine Task Is Still Running	20080320
19	SET_ENGINE_PARAMETER	Static method	Public	Method	Set Engine Parameters	20080320
20	SET_ENGINE_TASK_INFOS	Static method	Public	Method	Transfer Engine Task Information	20080320
21	SET_STOP_FLAG	Static method	Public	Method	Sets Stop Flag	20080320

Events

Class CL_RCC_COMMOBJECT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTYS_CALLBACK	Private	See coding			20080320	BEGIN OF ltys_callback, session_guid TYPE RCC_GUID, inst_ref TYPE REF TO IF_RCC_COMMHOOK, END OF ltys_callback
2	LTYT_CALLBACKS	Private	See coding			20080320	ltyt_callbacks TYPE HASHED TABLE OF ltys_callback WITH UNIQUE key session_guid

Method Signatures

Method ADD_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_COMM_DATA	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_PARAM_TABLE		Tabelle für den Parametertransfer mit externen Engines	20080320
2	Importing	IV_METHOD_INTERFACE	Call by reference	☑	Type reference (TYPE)	RCC_COM_METHODINTF	IF_RCC_COMMOBJECT_C=>GC_MESSAGE	Methodeninterface der Kommunikationsschnittstelle	20080320
3	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-interne GUID	20080320

Method ADD_DATA on class CL_RCC_COMMOBJECT has no exception.

Method ADD_EXTRA_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_EXTRA_PARAMETER	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method ADD_EXTRA_PARAMETER on class CL_RCC_COMMOBJECT has no exception.

Method ADD_EXTRA_PARAMETER_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_EXTRA_PARAMETER	Call by reference	☐	Type reference (TYPE)	RCCS_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20080320
2	Importing	IT_COMM_DATA	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_PARAM_TABLE		Table for Parameter Transfer with External Engines	20080320
3	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method ADD_EXTRA_PARAMETER_INT on class CL_RCC_COMMOBJECT has no exception.

Method ADD_FINISH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_FINISH	Call by reference	☐	Type reference (TYPE)	RCCS_COMM_FINISH		Endergebnisinformationen im Kommunikationsobjekt	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method ADD_FINISH on class CL_RCC_COMMOBJECT has no exception.

Method ADD_FINISH_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_COMM_DATA	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_PARAM_TABLE		Tabelle für den Parametertransfer mit externen Engines	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-interne GUID	20080320

Method ADD_FINISH_INT on class CL_RCC_COMMOBJECT has no exception.

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MESSAGE	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_MESSAGE		Tabelle von Meldungsinformationen	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method ADD_MESSAGE on class CL_RCC_COMMOBJECT has no exception.

Method ADD_MESSAGE_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MESSAGE	Call by reference	☑	Type reference (TYPE)	RCCS_COMM_MESSAGE		Struktur der Message-Variablen	20080320
2	Importing	IT_COMM_DATA	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_PARAM_TABLE		Tabelle für den Parametertransfer mit externen Engines	20080320
3	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-interne GUID	20080320

Method ADD_MESSAGE_INT on class CL_RCC_COMMOBJECT has no exception.

Method ADD_PROGRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PROGRESS	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_MESSAGE		Tabelle von Meldungsinformationen	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method ADD_PROGRESS on class CL_RCC_COMMOBJECT has no exception.

Method ADD_PROGRESS_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_COMM_DATA	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_PARAM_TABLE		Tabelle für den Parametertransfer mit externen Engines	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-interne GUID	20080320

Method ADD_PROGRESS_INT on class CL_RCC_COMMOBJECT has no exception.

Method ADD_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RESULT	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_RESULT		Tabelle der Resultinformationen	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method ADD_RESULT on class CL_RCC_COMMOBJECT has no exception.

Method ADD_RESULT_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_COMM_DATA	Call by reference	☐	Type reference (TYPE)	RCCT_COMM_PARAM_TABLE		Tabelle für den Parametertransfer mit externen Engines	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-interne GUID	20080320

Method ADD_RESULT_INT on class CL_RCC_COMMOBJECT has no exception.

Method ATTACH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HOOK	Call by reference	☑	Object reference (TYPE REF TO)	IF_RCC_COMMHOOK		Interface to Join In Communication	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☑	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method ATTACH on class CL_RCC_COMMOBJECT has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method DETACH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HOOK	Call by reference	☐	Object reference (TYPE REF TO)	IF_RCC_COMMHOOK		Interface to Join In Communication	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method DETACH on class CL_RCC_COMMOBJECT has no exception.

Method FORCE_CLEAN Signature

Method FORCE_CLEAN on class CL_RCC_COMMOBJECT has no parameter.
Method FORCE_CLEAN on class CL_RCC_COMMOBJECT has no exception.

Method FREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method FREE on class CL_RCC_COMMOBJECT has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_METHOD_INTERFACE	Call by reference	☐	Type reference (TYPE)	RCC_COM_METHODINTF		Method Interface for Communication Interface	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320
3	Importing	IV_START_IDX	Call by reference	☐	Type reference (TYPE)	SYTABIX	1	Start Index as of Which Data Is Read	20080320
4	Returning	RT_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Communication Object Data	20080320

Method GET_DATA on class CL_RCC_COMMOBJECT has no exception.

Method IS_ENGINE_TASK_ALIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320
2	Returning	RV_ALIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080320

Method IS_ENGINE_TASK_ALIVE on class CL_RCC_COMMOBJECT has no exception.

Method SET_ENGINE_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SLOT	Call by reference	☐	Type reference (TYPE)	RCCS_DEST_SLOT		RCCF Engine Parameters Interface	20080320
2	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method SET_ENGINE_PARAMETER on class CL_RCC_COMMOBJECT has no exception.

Method SET_ENGINE_TASK_INFOS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	THFB_CONTEXT_ID			20080320
2	Importing	IV_CONTEXT_ID_LEN	Call by reference	☐	Type reference (TYPE)	I			20080320
3	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320
4	Importing	IV_SESSION_ID	Call by reference	☐	Type reference (TYPE)	THFB_SESSION_ID			20080320
5	Importing	IV_SESSION_ID_LEN	Call by reference	☐	Type reference (TYPE)	I			20080320
6	Importing	IV_TID	Call by reference	☐	Type reference (TYPE)	SYINDEX		Loop Index	20080320

Method SET_ENGINE_TASK_INFOS on class CL_RCC_COMMOBJECT has no exception.

Method SET_STOP_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SESSION_GUID	Call by reference	☐	Type reference (TYPE)	RCC_GUID		RCCF-Internal GUID	20080320

Method SET_STOP_FLAG on class CL_RCC_COMMOBJECT has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	604