SAP ABAP Class CL_RCC_EXTERNAL_INTERFACE (Functions for External Use)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-EPT-RCC (Application Component) Remote Control and Communication Framework
⤷
RCC_COMMON (Package) RCCF: Shared Objects
SAP_BS_FND (Software Component) SAP Business Suite Foundation⤷
CA-EPT-RCC (Application Component) Remote Control and Communication Framework⤷
RCC_COMMON (Package) RCCF: Shared ObjectsProperties
| Class | CL_RCC_EXTERNAL_INTERFACE | |
| Short Description | Functions for External Use | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | RCC_COMMON | RCCF: Shared Objects |
| 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 | IF_RCC_DATASTORAGE_C |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class CL_RCC_EXTERNAL_INTERFACE has no interface implemented.
Friends
Class CL_RCC_EXTERNAL_INTERFACE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MO_DB |
Static Attribute | Private | Object reference (TYPE REF TO) | IF_RCC_DATASTORAGE=> | RCCF Data Retention Interface | 20080320 | ||
| 2 | MT_RESERVATIONS |
Static Attribute | Private | Type reference (TYPE) | TY_LT_RESERVATION | Slots Reserved by this Class | 20080320 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20080320 |
| 2 | FREE |
Static method | Public | Method | Release of all system resources | 20080320 |
| 3 | FREE_SLOT |
Static method | Public | Method | Releases a Slot in RCCF | 20080320 |
| 4 | GET_ENGINE |
Static method | Public | Method | Provides Information for Engine(s) | 20080320 |
| 5 | GET_ENGINE_DESTINATION |
Static method | Public | Method | Get the engine destinations | 20110616 |
| 6 | GET_ENGINE_FILENAME |
Static method | Public | Method | Delivers the Correct Filename Including Time Stamp | 20080320 |
| 7 | GET_EXTRA_PARAMETER |
Static method | Public | Method | Cutomizing: Provide the User Parameter from rccf_param | 20080320 |
| 8 | GET_LOG_DELETION_TIME |
Static method | Public | Method | Customizing: Time Until Log Entries Are Cleaned Up | 20080320 |
| 9 | GET_LOG_ENTRY |
Static method | Public | Method | Return of Log Entry in RCCF | 20080320 |
| 10 | GET_SINGLE_EXTRA_PARAMETER |
Static method | Public | Method | Cutomizing: Provide the first User Parameter from rccf_param | 20090123 |
| 11 | IS_ENGINE_ACTIVE |
Static method | Public | Method | Checks Whether an Active Destination for Engine Exists | 20080320 |
| 12 | RESERVE_SLOT |
Static method | Public | Method | Reserves a Slot on a Destination Address in RCCF | 20080320 |
Events
Class CL_RCC_EXTERNAL_INTERFACE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_LS_RESERVATION | Private | See coding | 20080320 | BEGIN OF TY_LS_RESERVATION,
dest_id type RCC_DEST_ID,
slot_nr type RCC_SLOT_NUMBER,
end of ty_ls_reservation
|
||
| 2 | TY_LT_RESERVATION | Private | See coding | 20080320 | TY_LT_RESERVATION type HASHED TABLE OF TY_LS_RESERVATION WITH UNIQUE KEY dest_id slot_nr
|
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_RCC_EXTERNAL_INTERFACE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method FREE Signature
Method FREE on class CL_RCC_EXTERNAL_INTERFACE has no parameter.
Method FREE on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method FREE_SLOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_DESTID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | ID of Destination Address of External Engine in RCCF | 20080320 | ||
| 2 | Importing |
IV_SLOT_NR | Call by reference | Type reference (TYPE) | RCC_SLOT_NUMBER | Slot Number of Load Distribution in RCCF | 20080320 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_RCC_EXTERNAL_INTERFACE |
20080320 |
Method GET_ENGINE 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 | 20080320 | ||
| 2 |  Returning |
RT_ENGINE | Value transfer | Type reference (TYPE) | RCCT_ENGINE | Table of Application Engines | 20080320 |
Method GET_ENGINE on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method GET_ENGINE_DESTINATION 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 | 20110616 | ||
| 2 | Importing |
IV_COM_DEST | Call by reference | Type reference (TYPE) | RCC_COMDEST | Communication Connection | 20110616 | ||
| 3 | Importing |
IV_COM_TYPE | Call by reference | Type reference (TYPE) | RCC_COMTYPE | Communication Type with External Engines | 20110616 | ||
| 4 | Importing |
IV_DEST_ID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | Destination ID of External Engine in RCCF | 20110616 | ||
| 5 | Returning |
RT_DESTINATION | Value transfer | Type reference (TYPE) | RCCT_ENG_DESTINATION | Table of Destination Addresses for External Engines in RCCF | 20110616 |
Method GET_ENGINE_DESTINATION on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method GET_ENGINE_FILENAME 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 | 20080320 | ||
| 2 | Importing |
IV_CUSTOMIZINGID | Call by reference | Type reference (TYPE) | RCC_ENGINE_CUSTID | Customizing ID of the Engine Profile | 20080320 | ||
| 3 | Importing |
IV_DESTID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | ID of Destination Address of External Engine in RCCF | 20080320 | ||
| 4 | Importing |
IV_FILETYPE | Call by reference | Type reference (TYPE) | C | IF_RCC_FILE_C=>GC_TRACEFILE | Type of File to Be Created (Trace, Dump...) | 20080320 | |
| 5 | Importing |
IV_PROFILE | Call by reference | Type reference (TYPE) | RCC_ENGINE_PROFILE | Engine Profile | 20080320 | ||
| 6 | Importing |
IV_TIMESTAMP | Call by reference | Type reference (TYPE) | RCC_ENG_TIMESTAMP | Engine Run Status | 20080320 | ||
| 7 | Returning |
RV_FILENAME | Value transfer | Type reference (TYPE) | RCC_FILE_NAME | File Name in RCCF | 20080320 |
Method GET_ENGINE_FILENAME on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method GET_EXTRA_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_PARAMETER | Call by reference | Type reference (TYPE) | RCCS_DATA_CUSTOMERPARAMETER | User Parameter in RCCF | 20080320 | ||
| 2 | Importing |
IV_APP | Call by reference | Type reference (TYPE) | RCC_APP | RCCF Application ID | 20080320 | ||
| 3 | Importing |
IV_CUSTID | Call by reference | Type reference (TYPE) | RCC_PARAM_CUSTID | RCCF Parameter: Customizing ID | 20080320 | ||
| 4 | Importing |
IV_DESTID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | ID of Destination Address of External Engine in RCCF | 20080320 | ||
| 5 | Importing |
IV_PARAM_F_VAL | Call by reference | Type reference (TYPE) | RCC_PARAM_FLOAT_VALUE | RCCF Parameter: Floating Point Value | 20080320 | ||
| 6 | Importing |
IV_PARAM_I_VAL | Call by reference | Type reference (TYPE) | RCC_PARAM_INTEGER_VALUE | RCCF Parameter: Integer Value | 20080320 | ||
| 7 | Importing |
IV_PARAM_NAME | Call by reference | Type reference (TYPE) | RCC_PARAM_NAME | RCCF Parameter: Name | 20080320 | ||
| 8 | Importing |
IV_PARAM_SECTION | Call by reference | Type reference (TYPE) | RCC_PARAM_SECTION | RCCF Parameter: Section | 20080320 | ||
| 9 | Importing |
IV_PARAM_SWITCH | Call by reference | Type reference (TYPE) | RCC_PARAM_SWITCH | RCCF Parameter: Value Switch | 20080320 | ||
| 10 | Importing |
IV_PARAM_S_VAL | Call by reference | Type reference (TYPE) | RCC_PARAM_STRING_VALUE | RCCF Parameter: Character String | 20080320 | ||
| 11 | Importing |
IV_PROFILE | Call by reference | Type reference (TYPE) | RCC_PARAM_PROFILE | RCCF Parameter: Profile | 20080320 | ||
| 12 | Returning |
RT_PARAMETER | Value transfer | Type reference (TYPE) | RCCT_DATA_CUSTOMERPARAMETER | User Parameters | 20080320 |
Method GET_EXTRA_PARAMETER on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method GET_LOG_DELETION_TIME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_DAYS | Value transfer | Type reference (TYPE) | RCC_LOG_DELETIONTIME | Time Until Log Entries in RCCF Are Deleted [Days] | 20080320 |
Method GET_LOG_DELETION_TIME on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method GET_LOG_ENTRY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_LOGENTRY | Call by reference | Type reference (TYPE) | RCCS_LOG_ENTRY | Log Entry in Engine Log | 20080320 | ||
| 2 | Exporting |
ET_LOGENTRY | Call by reference | Type reference (TYPE) | RCCT_LOG_ENTRY | Table of Log Entries from Engine Run in RCCF | 20080320 | ||
| 3 | Importing |
IT_LOGHANDLE | Call by reference | Type reference (TYPE) | RCCT_LOG_HANDLE | Table of Log Handles of Multiple Log Entries | 20080320 | ||
| 4 | Importing |
IV_APP | Call by reference | Type reference (TYPE) | RCC_APP | RCCF Application ID | 20080320 | ||
| 5 | Importing |
IV_LOGHANDLE | Call by reference | Type reference (TYPE) | RCC_LOG_HANDLE | Log Handle of Exactly One Entry in RCCF | 20080320 | ||
| 6 | Importing |
IV_MSG_LOGHANDLE | Call by reference | Type reference (TYPE) | BALLOGHNDL | Application Log: Log Handle | 20080320 | ||
| 7 | Importing |
IV_STARTDATE | Call by reference | Type reference (TYPE) | RCC_ENG_STARTDATE | Start Date of an Engine Run in RCCF | 20080320 | ||
| 8 | Importing |
IV_STARTTIME | Call by reference | Type reference (TYPE) | RCC_ENG_STARTTIME | Start Time of an Engine Run in RCCF | 20080320 |
Method GET_LOG_ENTRY on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method GET_SINGLE_EXTRA_PARAMETER 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 | 20090123 | ||
| 2 | Importing |
IV_CUSTID | Call by reference | Type reference (TYPE) | RCC_PARAM_CUSTID | RCCF Parameter: Customizing ID | 20090123 | ||
| 3 | Importing |
IV_DEFAULT_VALUE | Call by reference | Type reference (TYPE) | RCC_PARAM_STRING_VALUE | '' | RCCF Parameter: Character String | 20090123 | |
| 4 | Importing |
IV_DESTID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | ID of Destination Address of External Engine in RCCF | 20090123 | ||
| 5 | Importing |
IV_PARAM_NAME | Call by reference | Type reference (TYPE) | RCC_PARAM_NAME | RCCF Parameter: Name | 20090123 | ||
| 6 | Importing |
IV_PARAM_SECTION | Call by reference | Type reference (TYPE) | RCC_PARAM_SECTION | RCCF Parameter: Section | 20090123 | ||
| 7 | Importing |
IV_PARAM_SWITCH | Call by reference | Type reference (TYPE) | RCC_PARAM_SWITCH | RCCF Parameter: Value Switch | 20090123 | ||
| 8 | Importing |
IV_PROFILE | Call by reference | Type reference (TYPE) | RCC_PARAM_PROFILE | RCCF Parameter: Profile | 20090123 | ||
| 9 | Returning |
RV_PARAMETER | Value transfer | Type reference (TYPE) | RCC_PARAM_STRING_VALUE | Value as a string | 20090123 |
Method GET_SINGLE_EXTRA_PARAMETER on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method IS_ENGINE_ACTIVE 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 | 20080320 | ||
| 2 | Importing |
IV_CHECK_AVAILABILITY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Check availability as well | 20090127 | |
| 3 | Importing |
IV_DEST_ID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | Destination ID of External Engine in RCCF | 20080320 | ||
| 4 | Returning |
RV_IS_ACTIVE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20080320 |
Method IS_ENGINE_ACTIVE on class CL_RCC_EXTERNAL_INTERFACE has no exception.
Method RESERVE_SLOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_DEST_ID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | ID of Destination Address of External Engine in RCCF | 20080320 | ||
| 2 | Exporting |
EV_SLOT_NR | Call by reference | Type reference (TYPE) | RCC_SLOT_NUMBER | Slot Number of Load Distribution in RCCF | 20080320 | ||
| 3 | Importing |
IV_APP | Call by reference | Type reference (TYPE) | RCC_APP | RCCF Application ID | 20080320 | ||
| 4 | Importing |
IV_DESTID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | ID of Destination Address of External Engine in RCCF | 20080320 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_RCC_COMMSTORE |
20080320 | ||
| 2 | CX_RCC_EXTERNAL_INTERFACE |
20080320 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 604 |
