SAP ABAP Class IF_RCC_ENGINE (RCCF Engine Interface)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_RCC_COM_DEFAULTPARAMETER | Default Parameter for RCCF Engines | 20080320 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_RCC_ENGINE | Basis Class for RCCF Engines | 20080320 |
Properties
| Class | IF_RCC_ENGINE | |
| Short Description | RCCF Engine Interface | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20080320 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class IF_RCC_ENGINE has no forward declaration.
Interfaces
Class IF_RCC_ENGINE has no interface implemented.
Friends
Class IF_RCC_ENGINE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MO_ENGINE_PARAMETER |
Instance attribute | Public | Object reference (TYPE REF TO) | IF_RCC_ENGINE_PARAMETER | RCCF Engine Parameters Interface | 20110609 | ||
| 2 | MO_LOG_CALLBACK |
Instance attribute | Public | Object reference (TYPE REF TO) | IF_RCC_LOG_CALLBACK | RCCF Log Callback Interface | 20080320 | ||
| 3 | MS_ENGINE_PARAMETER |
Instance attribute | Public | Type reference (TYPE) | RCCS_ENGINE_PARAMETER | Application-Relevant Engine Parameters | 20080320 | ||
| 4 | MV_APP |
Instance attribute | Public | Type reference (TYPE) | RCC_APP | RCCF Application ID | 20080320 | ||
| 5 | MV_ENGINE_RESULT |
Instance attribute | Public | Type reference (TYPE) | RCC_ENGINE_RESULT | Result/Status of External Engine in RCCF | 20110609 | ||
| 6 | MV_GUID |
Instance attribute | Public | Type reference (TYPE) | RCC_GUID | GUID to Identify Engine | 20080320 | ||
| 7 | MV_MODE |
Instance attribute | Public | Type reference (TYPE) | RCC_ENGINE_MODE | Engine Mode in RCCF (Tool or Application) | 20080320 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_ENGINE_MODE |
Instance method | Public | Method | Engine Mode (TOOL or APP) | 20080320 |
| 2 | GET_PARAMETER |
Instance method | Public | Method | "Outbound" Parameters to Engine | 20080320 |
| 3 | ON_AFTER_ENGAGE |
Instance method | Public | Method | After Slot Reservation Phase in Load Balancing | 20080320 |
| 4 | ON_FINALIZE |
Instance method | Public | Method | During End Phase | 20080320 |
| 5 | ON_INIT |
Instance method | Public | Method | During Initialization Phase | 20080320 |
| 6 | ON_SHUTDOWN |
Instance method | Public | Method | When the engine shuts down | 20110609 |
| 7 | SET_ENGINE_LOGHANDLE |
Instance method | Public | Method | Sets Log Handle of Engine Call as Later Reference | 20080320 |
| 8 | SET_ENGINE_RESULT |
Instance method | Public | Method | Set the engine result to the attribute | 20110609 |
| 9 | SET_MESSAGE |
Instance method | Public | Method | Inbound Messages from Engine | 20080320 |
| 10 | SET_PARAMETER |
Instance method | Public | Method | Inbound Parameters from Engine | 20080320 |
| 11 | SET_PERFINFO |
Instance method | Public | Method | Inbound Performance Information from Engine | 20080320 |
| 12 | SET_PROGRESS |
Instance method | Public | Method | Inbound Status Information from Engine | 20080320 |
| 13 | SET_RESULT |
Instance method | Public | Method | Inbound Result from Engine | 20080320 |
| 14 | SET_SLOT_INFO |
Instance method | Public | Method | Set the slot name | 20110722 |
| 15 | SET_SYSINFO |
Instance method | Public | Method | Inbound System Information from Engine | 20080320 |
Events
Class IF_RCC_ENGINE has no event.
Types
Class IF_RCC_ENGINE has no local type.
Method Signatures
Method GET_ENGINE_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RV_ENGINE_MODE | Value transfer | Type reference (TYPE) | RCC_ENGINE_MODE | Engine Mode in RCCF (Tool or Application) | 20080320 |
Method GET_ENGINE_MODE on class IF_RCC_ENGINE has no exception.
Method GET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_COMM_PARAMETER | Call by reference | Type reference (TYPE) | RCCT_COMM_PARAMETER | Table for Parameter Transfer with External Engines | 20080320 |
Method GET_PARAMETER on class IF_RCC_ENGINE has no exception.
Method ON_AFTER_ENGAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_COMMUNICATION | Call by reference | Object reference (TYPE REF TO) | IF_RCC_COMMUNICATION | RCCF Communication Interface | 20080320 |
Method ON_AFTER_ENGAGE on class IF_RCC_ENGINE has no exception.
Method ON_FINALIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_ENGINE_PARAMETER | Call by reference | Object reference (TYPE REF TO) | IF_RCC_ENGINE_PARAMETER | Final Engine Parameters | 20080320 |
Method ON_FINALIZE on class IF_RCC_ENGINE has no exception.
Method ON_INIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_CURRENT_PARAMETER | Call by reference | Object reference (TYPE REF TO) | IF_RCC_ENGINE_PARAMETER | Current Engine Parameters | 20080320 |
Method ON_INIT on class IF_RCC_ENGINE has no exception.
Method ON_SHUTDOWN Signature
Method ON_SHUTDOWN on class IF_RCC_ENGINE has no parameter.
Method ON_SHUTDOWN on class IF_RCC_ENGINE has no exception.
Method SET_ENGINE_LOGHANDLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_LOGHANDLE | Call by reference | Type reference (TYPE) | RCC_LOG_HANDLE | Log Handle of Exactly One Entry in RCCF | 20080320 |
Method SET_ENGINE_LOGHANDLE on class IF_RCC_ENGINE has no exception.
Method SET_ENGINE_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ENGINE_RESULT | Call by reference | Type reference (TYPE) | RCC_ENGINE_RESULT | Result/Status of External Engine in RCCF | 20110609 |
Method SET_ENGINE_RESULT on class IF_RCC_ENGINE has no exception.
Method SET_MESSAGE 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 | Table for Parameter Transfer with External Engines | 20080320 |
Method SET_MESSAGE on class IF_RCC_ENGINE has no exception.
Method SET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_COMM_HEADER | Call by reference | Type reference (TYPE) | RCCS_COMM_PARAM_HEADER | Parameter Header for Communication with External Engines | 20080320 | ||
| 2 | Importing |
IT_COMM_DATA | Call by reference | Type reference (TYPE) | RCCT_COMM_PARAM_TABLE | Table for Parameter Transfer with External Engines | 20080320 |
Method SET_PARAMETER on class IF_RCC_ENGINE has no exception.
Method SET_PERFINFO 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 | Table for Parameter Transfer with External Engines | 20080320 |
Method SET_PERFINFO on class IF_RCC_ENGINE has no exception.
Method SET_PROGRESS 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 | Table for Parameter Transfer with External Engines | 20080320 |
Method SET_PROGRESS on class IF_RCC_ENGINE has no exception.
Method SET_RESULT 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 | Table for Parameter Transfer with External Engines | 20080320 |
Method SET_RESULT on class IF_RCC_ENGINE has no exception.
Method SET_SLOT_INFO 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_SLOT | 20110722 |
Method SET_SLOT_INFO on class IF_RCC_ENGINE has no exception.
Method SET_SYSINFO 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 | Table for Parameter Transfer with External Engines | 20080320 |
Method SET_SYSINFO on class IF_RCC_ENGINE has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
