SAP ABAP Class CL_RCC_SERVICE_CONSUMER (RCCF Service Consumer Main)
Hierarchy
☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-RCC (Application Component) Remote Control and Communication Framework
     ⤷ RCC_COM_SERVICE_CONSUMER (Package) RCCF: Communication: Service Consumer
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_RCC_SERVICE_ONDEMAND RCCF Service OnDemand Implemenation 20091029
Properties
Class CL_RCC_SERVICE_CONSUMER  
Short Description RCCF Service Consumer Main    
Super Class    
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package RCC_COM_SERVICE_CONSUMER   RCCF: Communication: Service Consumer 
Created 20090709   SAP 
Last change 20130531   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 CL_RCC_RUNTIME Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 IF_RCC_ENGINE_C Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class CL_RCC_SERVICE_CONSUMER has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_RCC_COMM_SERVICE 20091116 RCCF Service Communication Class
2 CL_RCC_SERVICE_PROFILE 20100104 RCCF Service Profile
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GV_APP Instance attribute Public Type reference (TYPE) RCC_APP RCCF Application ID 20100112
2 GV_S Instance attribute Private Type reference (TYPE) RCC_PARAM_STRING_VALUE for local define 20090731
3 MO_ENDPOINT Instance attribute Protected Object reference (TYPE REF TO) IF_RCC_SERVICE_ENDPOINT RCC Service Endpoint 20091112
4 MO_ENGINE Instance attribute Protected Object reference (TYPE REF TO) IF_RCC_ENGINE RCCF Engine Interface 20110609
5 MO_PROFILE Instance attribute Public Object reference (TYPE REF TO) CL_RCC_SERVICE_PROFILE RCCF Service Profile 20100104
6 MS_SLOT Instance attribute Private Type reference (TYPE) RCCS_SLOT RCCF Service Slot Name 20110722
7 MV_LOGICALPORT Instance attribute Protected Type reference (TYPE) PRX_LOGICAL_PORT_NAME Logical Port Name 20090709
8 MV_LP_TEMPLATE_NAME Instance attribute Protected Type reference (TYPE) SRT_LP_NAME 'RCCF_SERVICE_CONSUMER' Logical Port Name 20100112
9 MV_REPORTMEM Instance attribute Private Type reference (TYPE) ABAP_BOOL 20090731
10 MV_REPORTTIME Instance attribute Private Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20090731
11 MV_RESEND_DATA Instance attribute Protected Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20090709
12 MV_SESSION Instance attribute Private Type reference (TYPE) RCC_GUID RCCF-Internal GUID 20091116
13 MV_TIMEACCURACY Instance attribute Private Type reference (TYPE) INT1 CL_RCC_RUNTIME=>MC_ACCURACY_SEC 20090731
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Protected Constructor CONSTRUCTOR 20090709
2 CONVERT_INITIAL_PARAMS Instance method Private Method Get and convert the initial execution parameters 20110301
3 CONVERT_OPTIONS Instance method Private Method Get and convert the internal options to an external format 20110301
4 EXECUTE Instance method Public Method Execute the Call to the Service 20090709
5 GET_FUMO_DATA Instance method Private Method Get next Data-BackCall from the RCCF Service 20110301
6 GET_FUMO_SIGNATURE Instance method Private Method Get next Signature-BackCall from the RCCF Service 20110301
7 GET_LP_TEMPLATE_NAME Instance method Public Method Get the default LP Name which is used as a copy Template 20100112
8 GET_OPERATION_SIGNATURE Instance method Private Method Get next Op. Sign. Request from the RCCF Service 20110309
9 GET_OPTIONS Instance method Private Method Get next Option Information (Parameter, Progress...) 20110301
10 GET_PROXYCLASS_NAME Instance method Protected Method # Get the Name of the Proxy Class (for Endpoint-Generation) 20091116
11 GET_SERVICE Static method Public Method Get a Service defined by a Unique Name 20090709
12 GET_SESSION Instance method Public Method Get the Current Session 20091116
13 GET_SLOT_INFO Instance method Public Method Get the service slot name 20110722
14 GET_STATUS Instance method Private Method Get the Runnint State of the RCCF Service 20091029
15 GET_TOOL_SERVICE Instance method Public Method Get Information on what to do with the Tool Mode 20100121
16 INIT_SERVICE Instance method Private Method Initialize the service 20110414
17 INNER_EXECUTE Instance method Protected Method # Execute the RCCF-Service-Class 20090709
18 INNER_GET_EXECUTE_PARAMETER Instance method Protected Method # Get additional Parameter for the execute 20110321
19 INNER_GET_FUMO_DATA Instance method Protected Method # Get the next call for Function Module Data 20110301
20 INNER_GET_FUMO_SIGNATURE Instance method Protected Method # Get the next call for a Function Module Signature 20110301
21 INNER_GET_OPERATION_SIGNATURE Instance method Protected Method # Get the next Signature Request for an Operation 20110309
22 INNER_GET_OPTIONS Instance method Protected Method # Get Option (Information) from the RCCF Service-Class 20110301
23 INNER_GET_SERVICE_STATUS Instance method Protected Method # Get the Running State of the RCCF Service 20090709
24 INNER_GET_TOOL_SERVICE Instance method Protected Method # Get the Tool Serivce Handler 20100121
25 INNER_INIT_SERVICE Instance method Protected Method # Tell the deriver to init the service now 20110414
26 INNER_IS_AVAILABLE Instance method Protected Method # Check if the service is available 20110414
27 IS_AVAILABLE Instance method Public Method Check if the service is available 20110414
28 SET_ENDPOINT Instance method Private Method Set the Service Endpoint for the next Calls 20091116
Events
Class CL_RCC_SERVICE_CONSUMER has no event.
Types
Class CL_RCC_SERVICE_CONSUMER has no local type.
Method Signatures

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_RCC_SERVICE_CONSUMER has no parameter.
Method CONSTRUCTOR on class CL_RCC_SERVICE_CONSUMER has no exception.

Method CONVERT_INITIAL_PARAMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_PARAMETER Call by reference Type reference (TYPE) RCCT_SERVICE_OPTION RCCF Service Option Information 20110301
2 Importing IT_PARAMETER Call by reference Type reference (TYPE) RCCT_COMM_PARAMETER Parameter Structure for Transferring All Parameters in RCCF 20110321

Method CONVERT_INITIAL_PARAMS on class CL_RCC_SERVICE_CONSUMER has no exception.

Method CONVERT_OPTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_OUT Call by reference Type reference (TYPE) RCCT_SERVICE_OPTION RCCF Service Option Information 20110301
2 Exporting ET_OUT_LEN Call by reference Type reference (TYPE) I Number of options 20110330
3 Importing IT_IN Call by reference Type reference (TYPE) RCCT_SERVICE_OPTION RCCF Service Option Information 20110301

Method CONVERT_OPTIONS on class CL_RCC_SERVICE_CONSUMER has no exception.

Method EXECUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_ENGINE Call by reference Object reference (TYPE REF TO) IF_RCC_ENGINE RCCF Engine Interface 20110609
2 Importing IS_ENGINE_PARAMETER Call by reference Type reference (TYPE) RCCS_ENGINE_PARAMETER Application-Relevant Engine Parameters 20090709
3 Importing IS_SLOT Call by reference Type reference (TYPE) RCCS_SLOT RCCF Slot Name 20110722
4 Importing IT_PARAMETER Call by reference Type reference (TYPE) RCCT_COMM_PARAMETER Parameter Structure for Transferring All Parameters in RCCF 20090709
5 Importing IV_APP Call by reference Type reference (TYPE) RCC_APP RCCF Application ID 20090709
6 Importing IV_DEST_ID Call by reference Type reference (TYPE) RCC_DEST_ID Destination ID of External Engine in RCCF 20110330
7 Importing IV_MODE Call by reference Type reference (TYPE) RCC_ENGINE_MODE IF_RCC_ENGINE_C=>GC_ENGINE_MODE_APPLICATION Engine Mode in RCCF (Tool or Application) 20090709
8 Importing IV_SESSION Call by reference Type reference (TYPE) RCC_GUID RCCF-Internal GUID 20091116
9 Importing IV_TOOLMODE_COMMAND Call by reference Type reference (TYPE) RCC_ENGINE_TOOL_MODE_COMMAND Command for the Engine Tool Mode 20091026
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCC Service Exceptions 20091112

Method GET_FUMO_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_IS_GZIP Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20110330
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20110301

Method GET_FUMO_SIGNATURE Signature

Method GET_FUMO_SIGNATURE on class CL_RCC_SERVICE_CONSUMER has no parameter.
Method GET_FUMO_SIGNATURE on class CL_RCC_SERVICE_CONSUMER has no exception.

Method GET_LP_TEMPLATE_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_LP_NAME Value transfer Type reference (TYPE) SRT_LP_NAME Logical Port Name 20100112

Method GET_LP_TEMPLATE_NAME on class CL_RCC_SERVICE_CONSUMER has no exception.

Method GET_OPERATION_SIGNATURE Signature

Method GET_OPERATION_SIGNATURE on class CL_RCC_SERVICE_CONSUMER has no parameter.
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20110309

Method GET_OPTIONS Signature

Method GET_OPTIONS on class CL_RCC_SERVICE_CONSUMER has no parameter.
Method GET_OPTIONS on class CL_RCC_SERVICE_CONSUMER has no exception.

Method GET_PROXYCLASS_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_PROXYCLASS Value transfer Type reference (TYPE) SRT_WSP_DT_OBJ_NAME WSP Name of Interface Object 20091116

Method GET_PROXYCLASS_NAME on class CL_RCC_SERVICE_CONSUMER has no exception.

Method GET_SERVICE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SERVICEHANDLER Call by reference Type reference (TYPE) RCC_ABAP_ABSTYPENAME 20091116
2 Returning RO_SERVICE Value transfer Object reference (TYPE REF TO) CL_RCC_SERVICE_CONSUMER RCCF Service Consumer Main 20090709
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCC Service Exceptions 20091112

Method GET_SESSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_SESSION Value transfer Type reference (TYPE) RCC_GUID RCCF-Internal GUID 20091116

Method GET_SESSION on class CL_RCC_SERVICE_CONSUMER has no exception.

Method GET_SLOT_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_SLOT Value transfer Type reference (TYPE) RCCS_SLOT RCCF Service Slot Name 20110722

Method GET_SLOT_INFO on class CL_RCC_SERVICE_CONSUMER has no exception.

Method GET_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_STATUS Value transfer Type reference (TYPE) RCCS_SERVICE_STATUS_RETURN Status of Destination Entry in RCCF 20110414
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20091116

Method GET_TOOL_SERVICE 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) RCC_APP RCCF Application ID 20100121
2 Importing IV_DEST_ID Call by reference Type reference (TYPE) RCC_DEST_ID Destination ID of External Engine in RCCF 20100121
3 Importing IV_TOOL_MODE_COMMAND Call by reference Type reference (TYPE) RCC_ENGINE_TOOL_MODE_COMMAND Command for the Engine Tool Mode 20100121
4 Returning RO_TOOL_SERVICE Value transfer Object reference (TYPE REF TO) IF_RCC_SERVICE_TOOLMODE RCCF Service for the Tool Mode 20100121

Method GET_TOOL_SERVICE on class CL_RCC_SERVICE_CONSUMER has no exception.

Method INIT_SERVICE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_ENGINE Call by reference Object reference (TYPE REF TO) IF_RCC_ENGINE RCCF Engine Interface 20110610
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20110414

Method INNER_EXECUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_START_INFO Call by reference Type reference (TYPE) RCCS_SERVICE_START_INFORMATION RCCF Service Start Information 20091116
2 Returning RS_STATUS Value transfer Type reference (TYPE) RCCS_SERVICE_STATUS_INFO RCCF Service Status Information 20110415
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20091116

Method INNER_GET_EXECUTE_PARAMETER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_PARAMETER Value transfer Type reference (TYPE) RCCT_COMM_PARAMETER Parameter Structure for Transferring All Parameters in RCCF 20110321

Method INNER_GET_EXECUTE_PARAMETER on class CL_RCC_SERVICE_CONSUMER has no exception.

Method INNER_GET_FUMO_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_FUMO_DATA Call by reference Type reference (TYPE) RCCS_SERVICE_FUMO_DATA_INFO RCCF Service Task Information 20110301
2 Importing IS_STATUS Call by reference Type reference (TYPE) RCCS_SERVICE_STATUS_INFO RCCF Service Status Information 20110301
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20110301

Method INNER_GET_FUMO_SIGNATURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_FUMO_SIGNATURE Call by reference Type reference (TYPE) RCCS_SERVICE_FUMO_SIG_INFO RCCF Service Function Module Signature 20110301
2 Importing IS_STATUS Call by reference Type reference (TYPE) RCCS_SERVICE_STATUS_INFO RCCF Service Status Information 20110301
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20110301

Method INNER_GET_OPERATION_SIGNATURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_SIG_REQUEST Call by reference Type reference (TYPE) RCCS_SERVICE_SIG_INFORMATION RCCF Service Signature Information 20110309
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20110309

Method INNER_GET_OPTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_OPTIONS Call by reference Type reference (TYPE) RCCT_SERVICE_OPTION 20110301
2 Importing IS_STATUS Call by reference Type reference (TYPE) RCCS_SERVICE_STATUS_INFO RCCF Service Status Information 20110301
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20110301

Method INNER_GET_SERVICE_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_STATUS Value transfer Type reference (TYPE) RCCS_SERVICE_STATUS_RETURN RCCF service status returning information 20110414
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20091116

Method INNER_GET_TOOL_SERVICE 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) RCC_APP RCCF Application ID 20100121
2 Importing IV_DEST_ID Call by reference Type reference (TYPE) RCC_DEST_ID Destination ID of External Engine in RCCF 20100121
3 Importing IV_TOOL_MODE_COMMAND Call by reference Type reference (TYPE) RCC_ENGINE_TOOL_MODE_COMMAND Command for the Engine Tool Mode 20100121
4 Returning RO_TOOL_SERVICE Value transfer Object reference (TYPE REF TO) IF_RCC_SERVICE_TOOLMODE RCCF Service for the Tool Mode 20100121

Method INNER_GET_TOOL_SERVICE on class CL_RCC_SERVICE_CONSUMER has no exception.

Method INNER_INIT_SERVICE Signature

Method INNER_INIT_SERVICE on class CL_RCC_SERVICE_CONSUMER has no parameter.
# Exception Resumable Description Created on
1 CX_RCC_SERVICE RCCF Service Exceptions 20110414

Method INNER_IS_AVAILABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_AVAILABLE Value transfer Type reference (TYPE) ABAP_BOOL 20110414

Method INNER_IS_AVAILABLE on class CL_RCC_SERVICE_CONSUMER has no exception.

Method IS_AVAILABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_AVAILABLE Value transfer Type reference (TYPE) ABAP_BOOL 20110414

Method IS_AVAILABLE on class CL_RCC_SERVICE_CONSUMER has no exception.

Method SET_ENDPOINT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_ENDPOINT Call by reference Object reference (TYPE REF TO) IF_RCC_SERVICE_ENDPOINT RCC Service Endpoint 20091116

Method SET_ENDPOINT on class CL_RCC_SERVICE_CONSUMER has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 702