SAP ABAP Class CL_RCC_SIMPLE_ENGINE (RCCF: Simple Engine Wrapper)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-EPT-RCC (Application Component) Remote Control and Communication Framework
⤷
RCC_ENGINE (Package) RCCF: Engine
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_RCC_ENGINE_EVENTS | RCCF Engine Event Interface | 20130307 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_RCC_SIMPLE_ENGINE | RCCF Simple Engine Interface | 20130322 |
Properties
| Class | CL_RCC_SIMPLE_ENGINE | |
| Short Description | RCCF: Simple Engine Wrapper | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | RCC_ENGINE | RCCF: Engine |
| Created | 20130307 | SAP |
| Last change | 20131127 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_RCC_ENGINE_EVENTS | RCCF Engine Event Interface | 20130307 | ||
| 2 | IF_RCC_SIMPLE_ENGINE | RCCF Simple Engine Interface | 20130322 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_RCC_SIMPLE_ENGINE_EXTRAS | 20130704 | RCCF: Simple Engine Enhancements | |
| 2 | CL_RCC_SIMPLE_EVENTHANDLER | 20130307 | RCCF: Simple Engine Eventhandler |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_RCC_ENGINE | 20130307 | ||||
| 2 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_RCC_ENGINE_PARAMETER | RCCF Engine Parameters Interface | 20130704 | |||
| 3 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_RCC_SIMPLE_ENGINE_EXTRAS | RCCF Simple Engine Extra Methods | 20130704 | |||
| 4 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_RCC_LOG_CALLBACK | RCCF Log Callback Interface | 20130704 | |||
| 5 | Instance attribute | Private | Type reference (TYPE) | RCCS_SLOT | RCCF Slot data | 20130704 | |||
| 6 | Instance attribute | Private | Type reference (TYPE) | RCCT_COMM_PARAMETER | 20130307 | ||||
| 7 | Instance attribute | Private | Type reference (TYPE) | RCC_DEST_ID | Destination ID of External Engine in RCCF | 20130704 | |||
| 8 | Instance attribute | Private | Type reference (TYPE) | BALLOGHNDL | Application Log: Log Handle | 20130704 | |||
| 9 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130307 | |||
| 10 | Instance attribute | Private | Type reference (TYPE) | RCC_SLOT_MAXIMUM | 1 | Maximum number of slots which should be reserved | 20130704 | ||
| 11 | Instance attribute | Private | Type reference (TYPE) | RCC_SLOT_MINIMUM | 1 | Minimum number of slots which should be reserved | 20130704 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Add the default parameters for the engine | 20130307 | |
| 2 | Instance method | Public | Method | 20130307 | ||
| 3 | Instance method | Public | Method | 20130307 | ||
| 4 | Instance method | Protected | Method | Call the RCCF engine | 20130307 | |
| 5 | Instance method | Public | Method | 20130704 | ||
| 6 | Instance method | Protected | Method | Get the function modules relevant for data exchange | 20130307 | |
| 7 | Instance method | Protected | Method | Get the debug flags (trace-level, dump-level) | 20130307 | |
| 8 | Instance method | Protected | Method | Get the engine application ID (e.g. TVSO, TFSM...) | 20130307 | |
| 9 | Instance method | Protected | Method | Get the software product name (e.g. SAPTM, SCM...) | 20130307 | |
| 10 | Instance method | Private | Method | Get the software product version | 20130307 | |
| 11 | Instance method | Private | Method | Raise a "message received" event | 20130307 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | AFTER_ENGAGE | Instance Event (0) |
Private (0) |
20130307 | |
| 2 | AFTER_INIT | Instance Event (0) |
Private (0) |
20130307 | |
| 3 | BEFORE_FINALIZE | Instance Event (0) |
Private (0) |
20130307 | |
| 4 | MESSAGE_RECEIVE | Instance Event (0) |
Public (2) |
20130307 | |
| 5 | PARAMETER_RECEIVE | Instance Event (0) |
Private (0) |
20130307 | |
| 6 | PARAMETER_REQUEST | Instance Event (0) |
Private (0) |
20130307 | |
| 7 | PERFINFO_RECEIVE | Instance Event (0) |
Private (0) |
20130307 | |
| 8 | PROGRESS_RECEIVE | Instance Event (0) |
Private (0) |
20130307 | |
| 9 | RESULT_RECEIVE | Instance Event (0) |
Private (0) |
20130307 | |
| 10 | SHUTDOWN | Instance Event (0) |
Private (0) |
20130307 | |
| 11 | SYSINFO_RECEIVE | Instance Event (0) |
Private (0) |
20130307 |
Types
Class CL_RCC_SIMPLE_ENGINE has no local type.
Method Signatures
Method ADD_GENERAL_PARAMETER Signature
Method ADD_GENERAL_PARAMETER on class CL_RCC_SIMPLE_ENGINE has no parameter.
Method ADD_GENERAL_PARAMETER on class CL_RCC_SIMPLE_ENGINE has no exception.
Method ADD_LOG_MESSAGE Signature
Method ADD_LOG_MESSAGE on class CL_RCC_SIMPLE_ENGINE has no parameter.
Method ADD_LOG_MESSAGE on class CL_RCC_SIMPLE_ENGINE has no exception.
Method ADD_PARAMETER Signature
Method ADD_PARAMETER on class CL_RCC_SIMPLE_ENGINE has no parameter.
Method ADD_PARAMETER on class CL_RCC_SIMPLE_ENGINE has no exception.
Method ENGINE_CALL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_OPT_PROFILE | Call by reference | Type reference (TYPE) | RCC_PARAM_PROFILE | 20130307 | ||||
| 2 | IV_OPT_PROFILE_CUSTID | Call by reference | Type reference (TYPE) | RCC_PARAM_CUSTID | 20130307 | ||||
| 3 | IV_OPT_RUNTIME | Call by reference | Type reference (TYPE) | RCC_RUNTIME | 20130307 | ||||
| 4 | RV_RESULT | Value transfer | Type reference (TYPE) | RCC_ENGINE_RESULT | 20130307 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130307 |
Method EXTRAS Signature
Method EXTRAS on class CL_RCC_SIMPLE_ENGINE has no parameter.
Method EXTRAS on class CL_RCC_SIMPLE_ENGINE has no exception.
Method GET_DATAXCHANGE_MODULES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_DOWNLOAD_MODULE | Call by reference | Type reference (TYPE) | FUNCNAME | Engine gets data from this module | 20130307 | |||
| 2 | EV_UPLOAD_MODULE | Call by reference | Type reference (TYPE) | FUNCNAME | Engine uploads result data to this module | 20130307 |
Method GET_DATAXCHANGE_MODULES on class CL_RCC_SIMPLE_ENGINE has no exception.
Method GET_DEBUG_FLAGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_DUMPLEVEL | Call by reference | Type reference (TYPE) | RCC_ENGINE_DUMPLEVEL | 20130307 | ||||
| 2 | EV_TRACELEVEL | Call by reference | Type reference (TYPE) | RCC_ENGINE_TRACELEVEL | 20130307 |
Method GET_DEBUG_FLAGS on class CL_RCC_SIMPLE_ENGINE has no exception.
Method GET_ENGINE_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_ENGINE_APP | Value transfer | Type reference (TYPE) | RCC_APP | RCCF Application ID | 20130307 |
Method GET_ENGINE_ID on class CL_RCC_SIMPLE_ENGINE has no exception.
Method GET_SOFTWARE_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_SOFTWARE_LAYER | Value transfer | Type reference (TYPE) | DLVUNIT | Software Component | 20130307 |
Method GET_SOFTWARE_ID on class CL_RCC_SIMPLE_ENGINE has no exception.
Method GET_SYSTEM_VALUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_ENGINE_PARAMETER | Call by reference | Type reference (TYPE) | RCCS_ENGINE_PARAMETER | 20130307 |
Method GET_SYSTEM_VALUES on class CL_RCC_SIMPLE_ENGINE has no exception.
Method RAISE_MESSAGE_RECEIVED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_COMM_DATA | Call by reference | Type reference (TYPE) | RCCT_COMM_PARAM_TABLE | 20130307 |
Method RAISE_MESSAGE_RECEIVED on class CL_RCC_SIMPLE_ENGINE has no exception.
Event Signatures
Event AFTER_ENGAGE Signature
Event AFTER_ENGAGE on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event AFTER_INIT Signature
Event AFTER_INIT on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event BEFORE_FINALIZE Signature
Event BEFORE_FINALIZE on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event MESSAGE_RECEIVE Signature
Event MESSAGE_RECEIVE on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event PARAMETER_RECEIVE Signature
Event PARAMETER_RECEIVE on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event PARAMETER_REQUEST Signature
Event PARAMETER_REQUEST on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event PERFINFO_RECEIVE Signature
Event PERFINFO_RECEIVE on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event PROGRESS_RECEIVE Signature
Event PROGRESS_RECEIVE on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event RESULT_RECEIVE Signature
Event RESULT_RECEIVE on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event SHUTDOWN Signature
Event SHUTDOWN on class CL_RCC_SIMPLE_ENGINE has no parameter.
Event SYSINFO_RECEIVE Signature
Event SYSINFO_RECEIVE on class CL_RCC_SIMPLE_ENGINE has no parameter.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 747 |