SAP ABAP Interface IF_RCC_DATASTORAGE (RCCF Data Retention Interface)
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 Objects
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_RCC_DATASTORAGE_DB | Data Storage in the Database | 20080320 |
Properties
| Interface | IF_RCC_DATASTORAGE | |
| Short Description | RCCF Data Retention Interface |
General Data
| Package | RCC_COMMON | RCCF: Shared Objects |
| Created | 20080320 | SAP |
| Last changed | 20130531 | SAP |
| 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) |
Interfaces
Interface IF_RCC_DATASTORAGE has no interface.
Friends
Interface IF_RCC_DATASTORAGE has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MV_DATA_STORAGETYPE | Instance attribute | Public | Type reference (TYPE) | RCC_DATA_STORAGETYPE | Data Store Type in RCCF | 20080320 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_CALLBACKS |
Instance method | Public | Method | Get Callback Modules for an Application | 20080320 |
| 2 | GET_CURRENT_SLOTS |
Instance method | Public | Method | Get Current Slot Table | 20080320 |
| 3 | GET_DEFAULT_PARAMETER |
Instance method | Public | Method | Reads General Customizing Parameter in RCCF | 20080320 |
| 4 | GET_DESTINATIONS |
Instance method | Public | Method | Get Destination Addresses for an Application | 20080320 |
| 5 | GET_ENGINE_INFO |
Instance method | Public | Method | Get Application Specific Information | 20080320 |
| 6 | GET_ENGINE_STOP_STATUS |
Instance method | Public | Method | Provides Stop Status of the Engine | 20080320 |
| 7 | GET_EXTRAPARAMETER |
Instance method | Public | Method | Get Additional Parameters from Customizing Table | 20080320 |
| 8 | GET_SECURE_FUNCTIONS |
Instance method | Public | Method | Get the Secure Functions | 20100122 |
| 9 | GET_SERVICE_PROFILE_HANDLER |
Instance method | Public | Method | Get the Service Profile Handler | 20091110 |
| 10 | GET_SERVICE_PROFILE_NAMES |
Instance method | Public | Method | Get the Service Profile Names | 20091116 |
| 11 | HANDLE_DESTINATION |
Instance method | Public | Method | Edit Destinations (Add, Delete or Update) | 20080320 |
| 12 | HANDLE_EXTRAPARAMETER |
Instance method | Public | Method | Edit additional parameter (Add, Delete or Update) | 20080320 |
| 13 | HANDLE_LOGENTRY |
Instance method | Public | Method | Edit Log Entry (Add, Delete Or Update) | 20080320 |
| 14 | HANDLE_SERVICE_PROFILE |
Instance method | Public | Method | Handle access to Service Profiles (Add, Delete, Update) | 20091029 |
| 15 | HANDLE_SLOT |
Instance method | Public | Method | Edit Slot (Release or Reserve) | 20080320 |
| 16 | IS_APP_VALID |
Instance method | Public | Method | Checks Whether Application ID Exists in the Database | 20080320 |
| 17 | LOCK_SLOTCOLLECTION |
Instance method | Public | Method | Lock Slot Table | 20080320 |
| 18 | UNLOCK_SLOTCOLLECTION |
Instance method | Public | Method | Release Slot Table | 20080320 |
Events
Interface IF_RCC_DATASTORAGE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_GT_LOGHANDLE_RANGE | Public | See coding | 20080320 | ty_gt_loghandle_range TYPE RANGE OF RCC_LOG_HANDLE
|
Method Signatures
Method GET_CALLBACKS 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 |
Method GET_CALLBACKS on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_CURRENT_SLOTS 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_ENGAGED_SLOTS | Value transfer | Type reference (TYPE) | RCCT_DEST_SLOT | Table of Reserved Destination Addresses in RCCF | 20080320 |
Method GET_CURRENT_SLOTS on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_DEFAULT_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RS_PARAMETER | Value transfer | Type reference (TYPE) | RCCS_GENERAL_PARAMETER | General Parameters in RCCF Set by User | 20080320 |
Method GET_DEFAULT_PARAMETER on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_DESTINATIONS 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 | Only this Application Type | 20080320 | ||
| 2 | Importing |
IV_DEST_COMDEST | Call by reference | Type reference (TYPE) | RCC_COMDEST | Communication Connection | 20110616 | ||
| 3 | Importing |
IV_DEST_COMTYPE | 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 | ID of Destination Address of External Engine in RCCF | 20080320 | ||
| 5 | Importing |
IV_STATUS | Call by reference | Type reference (TYPE) | RCC_STATUS | Only Destination Addresses with this Status | 20080320 | ||
| 6 | Returning |
RT_DESTINATIONS | Value transfer | Type reference (TYPE) | RCCT_ENG_DESTINATION | Table of Destination Addresses for External Engines in RCCF | 20080320 |
Method GET_DESTINATIONS on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_ENGINE_INFO 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_ENGINES | Value transfer | Type reference (TYPE) | RCCT_ENGINE | Table of Application Engines | 20080320 |
Method GET_ENGINE_INFO on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_ENGINE_STOP_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SLOT_DEST_ID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | Destination Address ID of External Engine in RCCF | 20080320 | ||
| 2 | Importing |
IV_SLOT_NO | Call by reference | Type reference (TYPE) | RCC_SLOT_NUMBER | Slot Number of Load Distribution in RCCF | 20080320 | ||
| 3 | Returning |
RV_IS_STOPPED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20080320 |
Method GET_ENGINE_STOP_STATUS on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_EXTRAPARAMETER 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 | Character-Like Identifier | 20080320 | ||
| 5 | Importing |
IV_PARAM_F_VAL | Call by reference | Type reference (TYPE) | RCC_PARAM_FLOAT_VALUE | RCCF Parameter: Float 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: String Value | 20080320 | ||
| 11 | Importing |
IV_PROFILE | Call by reference | Type reference (TYPE) | RCC_PARAM_PROFILE | RCCF Parameter: Profile | 20080320 | ||
| 12 | Importing |
IV_USEPROFILEPATTERNMATCHING | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Use Pattern Matching for Profile Check | 20080320 | |
| 13 | Returning |
RT_PARAMETER | Value transfer | Type reference (TYPE) | RCCT_DATA_CUSTOMERPARAMETER | User Parameter in RCCF | 20080320 |
Method GET_EXTRAPARAMETER on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_SECURE_FUNCTIONS 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 | 20100122 | ||
| 2 | Importing |
IV_DEST_ID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | Destination ID of External Engine in RCCF | 20100122 | ||
| 3 | Importing |
IV_FUNCNAME | Call by reference | Type reference (TYPE) | FUNCNAME | Function name | 20100122 | ||
| 4 | Returning |
RT_SECURE_FUNCTION | Value transfer | Type reference (TYPE) | RCCT_SECURE_FUNCTION | RCCF Secure Function Table | 20100122 |
Method GET_SECURE_FUNCTIONS on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_SERVICE_PROFILE_HANDLER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_HANDLER_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROF_HANDLERNAME | Service Profile Handler ID | 20091110 | ||
| 2 | Returning |
RT_PROFILE_HANDLER | Value transfer | Type reference (TYPE) | RCCT_SERVICE_PROF_HANDLER | Service Profile Handler Table | 20091110 |
Method GET_SERVICE_PROFILE_HANDLER on Interface IF_RCC_DATASTORAGE has no exception.
Method GET_SERVICE_PROFILE_NAMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_PROFILE_NAME | Value transfer | Type reference (TYPE) | RCCT_SERVICE_PROFILE_NAME | RCCF Service Profile Name Table | 20091116 |
Method GET_SERVICE_PROFILE_NAMES on Interface IF_RCC_DATASTORAGE has no exception.
Method HANDLE_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_DESTINATION | Call by reference | Type reference (TYPE) | RCCS_ENG_DESTINATION | Destinations of External Engines in RCCF | 20080320 | ||
| 2 | Importing |
IV_ACTION | Call by reference | Type reference (TYPE) | CHAR01 | Character Field Length 1 | 20080320 |
Method HANDLE_DESTINATION on Interface IF_RCC_DATASTORAGE has no exception.
Method HANDLE_EXTRAPARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_EXTRAPARAMETER | Call by reference | Type reference (TYPE) | RCCS_DATA_CUSTOMERPARAMETER | User Parameter in RCCF | 20080320 | ||
| 2 | Importing |
IV_ACTION | Call by reference | Type reference (TYPE) | CHAR01 | Character Field Length 1 | 20080320 |
Method HANDLE_EXTRAPARAMETER on Interface IF_RCC_DATASTORAGE has no exception.
Method HANDLE_LOGENTRY 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 | Exporting |
EV_SUCCESS | Call by reference | Type reference (TYPE) | ABAP_BOOL | Status of Last Operation | 20080320 | ||
| 4 | Importing |
IS_LOGENTRY | Call by reference | Type reference (TYPE) | RCCS_LOG_ENTRY | Log Entry in Engine Log | 20080320 | ||
| 5 | Importing |
IT_LOGHANDLE | Call by reference | Type reference (TYPE) | TY_GT_LOGHANDLE_RANGE | Range Table of Log Handles | 20080320 | ||
| 6 | Importing |
IV_ACTION | Call by reference | Type reference (TYPE) | CHAR01 | 'U'pdate, 'I'nsert, 'D'elete, 'S'elect | 20080320 | ||
| 7 | Importing |
IV_IN_UPDATE_TASK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20080320 | ||
| 8 | Importing |
IV_LOGHANDLE | Call by reference | Type reference (TYPE) | RCC_LOG_HANDLE | Log Handle of Exactly One Entry in RCCF | 20080320 | ||
| 9 | Importing |
IV_RETURN_MULTI | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Return Multiple Entries if Possible? | 20080320 | |
| 10 | Importing |
IV_SKIP_INITIAL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Skip Initial Value | 20080320 | |
| 11 | Importing |
IV_TO_DATE | Call by reference | Type reference (TYPE) | DATS | Date Upto (!) Which Is Read | 20080320 |
Method HANDLE_LOGENTRY on Interface IF_RCC_DATASTORAGE has no exception.
Method HANDLE_SERVICE_PROFILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_PROFILE | Call by reference | Type reference (TYPE) | RCCS_SERVICE_PROFILE | RCCF Service Profile | 20091116 | ||
| 2 | Exporting |
ET_PROFILE | Call by reference | Type reference (TYPE) | RCCT_SERVICE_PROFILE | RCCF Service Profile Table | 20091116 | ||
| 3 | Exporting |
EV_COUNT | Call by reference | Type reference (TYPE) | I | 20091116 | |||
| 4 | Importing |
IS_PROFILE | Call by reference | Type reference (TYPE) | RCCS_SERVICE_PROFILE | RCCF Service Profile | 20091116 | ||
| 5 | Importing |
IT_PROFILE | Call by reference | Type reference (TYPE) | RCCT_SERVICE_PROFILE | RCCF Service Profile Table | 20091116 | ||
| 6 | Importing |
IV_ACTION | Call by reference | Type reference (TYPE) | CHAR01 | Character Field Length 1 | 20091029 | ||
| 7 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROFILENAME | RCCF Service Profile Name | 20091029 |
Method HANDLE_SERVICE_PROFILE on Interface IF_RCC_DATASTORAGE has no exception.
Method HANDLE_SLOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTION | Call by reference | Type reference (TYPE) | CHAR01 | Character Field of Length 1 | 20080320 | ||
| 2 | Importing |
IV_DEST_ID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | Character-Like Identifier | 20080320 | ||
| 3 | Importing |
IV_HAS_ERROR | Call by reference | Type reference (TYPE) | INT1 | 2 | GUIMSG_INFO_LEVEL = 2 | 20080725 | |
| 4 | Importing |
IV_HOSTNAME | Call by reference | Type reference (TYPE) | RCC_ENG_HOSTNAME | Host Name on Which the External Engine Runs | 20080320 | ||
| 5 | Importing |
IV_IS_STOPPED | Call by reference | Type reference (TYPE) | BOOLE_D | Stop Flag | 20080320 | ||
| 6 | Importing |
IV_NUMSLOTS | Call by reference | Type reference (TYPE) | RCC_SLOT_USEDNUMBER | 1 | Number of Reserved Slots | 20080320 | |
| 7 | Importing |
IV_PROCID | Call by reference | Type reference (TYPE) | RCC_ENG_PROCID | Process ID of external Engine in RCCF | 20080320 | ||
| 8 | Importing |
IV_PROCNAME | Call by reference | Type reference (TYPE) | RCC_ENG_PROCNAME | Process Name of External Engine in RCCF | 20080320 | ||
| 9 | Importing |
IV_SLOT_ID | Call by reference | Type reference (TYPE) | RCC_SLOT_ID | RCCF Slot ID | 20110722 | ||
| 10 | Importing |
IV_SLOT_NAME | Call by reference | Type reference (TYPE) | RCC_SLOT_NAME | RCCF Slot Name | 20110705 | ||
| 11 | Importing |
IV_SLOT_NR | Call by reference | Type reference (TYPE) | RCC_SLOT_NUMBER | Natural number | 20080320 | ||
| 12 | Importing |
IV_STARTDATE | Call by reference | Type reference (TYPE) | RCC_ENG_STARTDATE | Start Date of an Engine Run in RCCF | 20080320 | ||
| 13 | Importing |
IV_STARTTIME | Call by reference | Type reference (TYPE) | RCC_ENG_STARTTIME | Start Time of an Engine Run in RCCF | 20080320 | ||
| 14 | Importing |
IV_USER | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080320 | ||
| 15 | Importing |
IV_WP_PID | Call by reference | Type reference (TYPE) | WPPID | Process Identification | 20080723 | ||
| 16 | Returning |
RV_SLOT_NR | Value transfer | Type reference (TYPE) | RCC_SLOT_NUMBER | Slot Number of Load Distribution in RCCF | 20080320 |
Method HANDLE_SLOT on Interface IF_RCC_DATASTORAGE has no exception.
Method IS_APP_VALID 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 |
RV_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | Does the Application ID Exist? | 20080320 |
Method IS_APP_VALID on Interface IF_RCC_DATASTORAGE has no exception.
Method LOCK_SLOTCOLLECTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_WAIT | Call by reference | Type reference (TYPE) | SAP_BOOL | 'X' | Boolean Variable (X=True, Space=False) | 20080320 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_RCC_DATASTORAGE |
20080320 | ||
| 2 | CX_RCC_EXCEPTION |
20080320 |
Method UNLOCK_SLOTCOLLECTION Signature
Method UNLOCK_SLOTCOLLECTION on Interface IF_RCC_DATASTORAGE has no parameter.
Method UNLOCK_SLOTCOLLECTION on Interface IF_RCC_DATASTORAGE has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 604 |
