SAP ABAP Class CL_RCC_SERVICE_PROFILE (RCCF Service Profile)
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 - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_RCC_SERVICE_PROFILE_FRIEND | RCCF Service Consumer Friend | 20091116 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_CSI_RCC_SERVICE_PROFILE | CSI RCCF Profile Implementation for Cloud Service Profiles | 20100105 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_RCC_SERVICE_PROFILE_RCCF | RCCF internal Service Profile Class | 20091110 |
Properties
| Class | CL_RCC_SERVICE_PROFILE | |
| Short Description | RCCF Service Profile | |
| 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 | 20091029 | SAP |
| Last change | 20130531 | 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) | |
| 2 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_RCC_SERVICE_PROFILE_FRIEND | RCCF Service Consumer Friend | 20091116 |
Friends
Class CL_RCC_SERVICE_PROFILE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Public | Type reference (TYPE) | RCC_APP | RCCF Application ID | 20100112 | |||
| 2 | Instance attribute | Public | Type reference (TYPE) | RCC_GUID | RCCF-Internal GUID | 20100112 | |||
| 3 | Static Attribute | Private | Object reference (TYPE REF TO) | IF_RCC_DATASTORAGE | RCCF Data Retention Interface | 20091029 | |||
| 4 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_RCC_SERVICE_CONSUMER | RCCF Service Consumer Main | 20110429 | |||
| 5 | Instance attribute | Private | Type reference (TYPE) | MTYT_SLOT_ENDPOINT | 20110429 | ||||
| 6 | Instance attribute | Private | Type reference (TYPE) | RCC_SERVICE_PROF_HANDLERNAME | Service Profile Handler ID | 20091110 | |||
| 7 | Instance attribute | Private | Type reference (TYPE) | RCC_SERVICE_PROFILENAME | RCCF Service Profile Name | 20091029 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Get the full name for a profile name | 20110616 | |
| 2 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20091029 | |
| 3 | Instance method | Protected | Constructor | CONSTRUCTOR | 20091029 | |
| 4 | Static method | Public | Method | Open or Create a Service Profile | 20091110 | |
| 5 | Static method | Public | Method | Get all Profiles from all Service Profile Handlers | 20091110 | |
| 6 | Instance method | Public | Method | # Get the Communication Endpoint from this Profile | 20091029 | |
| 7 | Instance method | Public | Method | Get the full name for a profile name | 20110616 | |
| 8 | Instance method | Public | Method | # Get the Name of this Profile | 20091112 | |
| 9 | Instance method | Public | Method | # Get all Profile Names from this Profile Handler | 20091110 | |
| 10 | Static method | Private | Method | Get the Profile from the Destination | 20091110 | |
| 11 | Instance method | Public | Method | Get the affected RCCF Service | 20091116 | |
| 12 | Instance method | Public | Method | # Get the Name of the Service Consumer Handler | 20091116 | |
| 13 | Static method | Public | Method | Is the provided Handler Name a correct one | 20091029 | |
| 14 | Static method | Public | Method | Is the Profile Name ok (not existing, correct format...) | 20100104 | |
| 15 | Instance method | Public | Method | Load the Profile Data | 20091110 | |
| 16 | Instance method | Protected | Method | # Load the Profile Data | 20091110 | |
| 17 | Instance method | Public | Method | Register a ServiceSlot (Instance...) | 20091112 | |
| 18 | Instance method | Protected | Method | # Register a ServiceSlot | 20091112 | |
| 19 | Instance method | Public | Method | Release a ServiceSlot (Instance...) | 20091112 | |
| 20 | Instance method | Protected | Method | # Release a ServiceSlot | 20091112 | |
| 21 | Instance method | Public | Method | Start the bound Service | 20100104 | |
| 22 | Instance method | Public | Method | Stop the bound Service (if supported by the service) | 20100104 |
Events
Class CL_RCC_SERVICE_PROFILE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | MTYS_SLOT_ENDPOINT | Private | See coding | 20110429 | begin of MTYS_SLOT_ENDPOINT,
slot type rcc_service_slot_name,
endpoint type ref to if_rcc_service_endpoint,
end of mtys_slot_endpoint
|
||
| 2 | MTYT_SLOT_ENDPOINT | Private | See coding | 20110429 | mtyt_slot_endpoint type hashed table of mtys_slot_endpoint with unique key slot
|
Method Signatures
Method BUILD_FULL_PROFILENAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HANDLER_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROF_HANDLERNAME | Service Profile Handler ID | 20110616 | |||
| 2 | IV_PROFILE_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROFILENAME | RCCF Service Profile Name | 20110616 | |||
| 3 | RV_SERVICE_DEST | Value transfer | Type reference (TYPE) | RCC_SERVICE_DEST | RCCF Service Destination | 20110616 |
Method BUILD_FULL_PROFILENAME on class CL_RCC_SERVICE_PROFILE has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_RCC_SERVICE_PROFILE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_RCC_SERVICE_PROFILE has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HANDLER_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROF_HANDLERNAME | Service Profile Handler ID | 20091110 | |||
| 2 | IV_PROFILE_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROFILENAME | RCCF Service Profile Name | 20091110 |
Method CONSTRUCTOR on class CL_RCC_SERVICE_PROFILE has no exception.
Method FACTORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROFILENAME | RCCF Service Profile Name | 20091110 | |||
| 2 | IV_SERVICE_DESTINATION | Call by reference | Type reference (TYPE) | RCC_SERVICE_DEST | RCCF Service Destination | 20091110 | |||
| 3 | RO_SERVICE_PROFILE | Value transfer | Object reference (TYPE REF TO) | CL_RCC_SERVICE_PROFILE | RCCF Service Profile | 20091110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20091110 |
Method GET_ALL_PROFILES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_HANDLER | Value transfer | Type reference (TYPE) | RCCT_SERVICE_DESTINATION | RCCF Service Destination Table | 20091110 |
Method GET_ALL_PROFILES on class CL_RCC_SERVICE_PROFILE has no exception.
Method GET_COMM_ENDPOINT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SLOT | Call by reference | Type reference (TYPE) | RCCS_SLOT | RCCF Service Slot Name | 20110722 | |||
| 2 | IV_LP_TEMPLATE_NAME | Call by reference | Type reference (TYPE) | SRT_LP_NAME | Copy Template | 20100112 | |||
| 3 | IV_PROXYCLASS_NAME | Call by reference | Type reference (TYPE) | SRT_WSP_DT_OBJ_NAME | WSP Name of Interface Object | 20091113 | |||
| 4 | RO_ENDPOINT | Value transfer | Object reference (TYPE REF TO) | IF_RCC_SERVICE_ENDPOINT | RCC Service Endpoint | 20091029 |
Method GET_COMM_ENDPOINT on class CL_RCC_SERVICE_PROFILE has no exception.
Method GET_FULL_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_PROFILE_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROFILENAME | RCCF Service Profile Name | 20110616 | |||
| 2 | RV_SERVICE_DEST | Value transfer | Type reference (TYPE) | RCC_SERVICE_DEST | RCCF Service Destination | 20110616 |
Method GET_FULL_NAME on class CL_RCC_SERVICE_PROFILE has no exception.
Method GET_HANDLER_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_HANDLERNAME | Value transfer | Type reference (TYPE) | RCC_SERVICE_PROF_HANDLERNAME | Service Profile Handler ID | 20091112 |
Method GET_HANDLER_NAME on class CL_RCC_SERVICE_PROFILE has no exception.
Method GET_PROFILES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_PROFILE_NAMES | Value transfer | Type reference (TYPE) | RCCT_SERVICE_PROFILE_NAME | RCCF Service Profile Name Table | 20091110 |
Method GET_PROFILES on class CL_RCC_SERVICE_PROFILE has no exception.
Method GET_PROFILE_FROM_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_HANDLER | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROF_HANDLERNAME | Service Profile Handler ID | 20091110 | |||
| 2 | EV_HANDLER_CLASS | Call by reference | Type reference (TYPE) | RCC_ABAP_ABSTYPENAME | Absolute Type Name in ABAP | 20091110 | |||
| 3 | EV_PROFILE | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROFILENAME | RCCF Service Profile Name | 20091110 | |||
| 4 | IV_SERVICE_DESTINATION | Call by reference | Type reference (TYPE) | RCC_SERVICE_DEST | RCCF Service Destination | 20091110 |
Method GET_PROFILE_FROM_DESTINATION on class CL_RCC_SERVICE_PROFILE has no exception.
Method GET_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_SERVICE | Value transfer | Object reference (TYPE REF TO) | CL_RCC_SERVICE_CONSUMER | RCCF Service Consumer Main | 20091116 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | RCCF Service Exceptions | 20100114 |
Method GET_SERVICEHANDLER_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_SERVICEHANDLER | Value transfer | Type reference (TYPE) | RCC_ABAP_ABSTYPENAME | Absolute Type Name in ABAP | 20091116 |
Method GET_SERVICEHANDLER_NAME on class CL_RCC_SERVICE_PROFILE has no exception.
Method IS_ALLOWED_HANDLER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HANDLERNAME | Call by reference | Type reference (TYPE) | RCC_ABAP_ABSTYPENAME | Absolute Type Name in ABAP | 20091029 | |||
| 2 | RV_ALLOWED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20091029 |
Method IS_ALLOWED_HANDLER on class CL_RCC_SERVICE_PROFILE has no exception.
Method IS_NAME_ALLOWED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_PROFILE_NAME | Call by reference | Type reference (TYPE) | RCC_SERVICE_PROFILENAME | RCCF Service Profile Name | 20100104 | |||
| 2 | RV_OK | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20100104 |
Method IS_NAME_ALLOWED on class CL_RCC_SERVICE_PROFILE has no exception.
Method LOAD Signature
Method LOAD on class CL_RCC_SERVICE_PROFILE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20091110 |
Method LOAD_PROFILE Signature
Method LOAD_PROFILE on class CL_RCC_SERVICE_PROFILE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20091110 |
Method REGISTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SLOT | Call by reference | Type reference (TYPE) | RCCS_SLOT | Predefine one slot | 20110722 | |||
| 2 | IT_SLOT | Call by reference | Type reference (TYPE) | RCCT_SLOT | Predefine multiple slots | 20110722 | |||
| 3 | IV_ALLOW_ON_DEMAND | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20100114 | |||
| 4 | IV_RESERVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | do we want to reserve that instance | 20110616 | ||
| 5 | IV_SERVICE_SLOT | Call by reference | Type reference (TYPE) | INT4 | Natural number | 20091112 | |||
| 6 | IV_SESSION | Call by reference | Type reference (TYPE) | RCC_GUID | RCCF-Internal GUID | 20091112 | |||
| 7 | RT_SLOTS | Value transfer | Type reference (TYPE) | RCCT_SLOT | RCCF Service Slot Name Table | 20110722 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | RCCF Service Profile Exception | 20091112 |
Method REGISTER_SLOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SLOT | Call by reference | Type reference (TYPE) | RCCS_SLOT | RCCF Slot data | 20110722 | |||
| 2 | IT_SLOT | Call by reference | Type reference (TYPE) | RCCT_SLOT | Slot information | 20110722 | |||
| 3 | IV_ALLOW_ON_DEMAND | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20100114 | |||
| 4 | IV_RESERVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20110616 | |||
| 5 | IV_SERVICE_SLOT | Call by reference | Type reference (TYPE) | INT4 | Natural number | 20091112 | |||
| 6 | IV_SESSION | Call by reference | Type reference (TYPE) | RCC_GUID | RCCF-Internal GUID | 20091112 | |||
| 7 | RT_SLOTS | Value transfer | Type reference (TYPE) | RCCT_SLOT | Slot information | 20110722 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | RCCF Service Profile Exception | 20091112 |
Method RELEASE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SLOT | Call by reference | Type reference (TYPE) | RCCS_SLOT | RCCF Service Slot Name | 20110722 | |||
| 2 | IT_SLOT | Call by reference | Type reference (TYPE) | RCCT_SLOT | RCCF Service Slot Name Table | 20110722 | |||
| 3 | IV_SESSION | Call by reference | Type reference (TYPE) | RCC_GUID | RCCF-Internal GUID | 20091112 | |||
| 4 | RV_OK | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20091112 |
Method RELEASE on class CL_RCC_SERVICE_PROFILE has no exception.
Method RELEASE_SLOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SLOT | Call by reference | Type reference (TYPE) | RCCS_SLOT | RCCF Slot data | 20110722 | |||
| 2 | IT_SLOT | Call by reference | Type reference (TYPE) | RCCT_SLOT | Slot information | 20110722 | |||
| 3 | IV_SESSION | Call by reference | Type reference (TYPE) | RCC_GUID | RCCF-Internal GUID | 20091112 | |||
| 4 | RV_OK | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20091112 |
Method RELEASE_SLOT on class CL_RCC_SERVICE_PROFILE has no exception.
Method SERVICE_EXECUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_ENGINE | Call by reference | Object reference (TYPE REF TO) | IF_RCC_ENGINE | RCCF Engine Interface | 20110609 | |||
| 2 | IS_ENGINE_PARAMETER | Call by reference | Type reference (TYPE) | RCCS_ENGINE_PARAMETER | Application-Relevant Engine Parameters | 20100104 | |||
| 3 | IS_SLOT | Call by reference | Type reference (TYPE) | RCCS_SLOT | RCCF Service Slot Name | 20110722 | |||
| 4 | IT_PARAMETER | Call by reference | Type reference (TYPE) | RCCT_COMM_PARAMETER | Parameter Structure for Transferring All Parameters in RCCF | 20100104 | |||
| 5 | IV_APP | Call by reference | Type reference (TYPE) | RCC_APP | RCCF Application ID | 20100104 | |||
| 6 | IV_DEST_ID | Call by reference | Type reference (TYPE) | RCC_DEST_ID | Destination ID of External Engine in RCCF | 20110330 | |||
| 7 | 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) | 20100104 | ||
| 8 | IV_SESSION | Call by reference | Type reference (TYPE) | RCC_GUID | RCCF-Internal GUID | 20100104 | |||
| 9 | IV_TOOLMODE_COMMAND | Call by reference | Type reference (TYPE) | RCC_ENGINE_TOOL_MODE_COMMAND | Command for the Engine Tool Mode | 20100104 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | RCCF Service Exceptions | 20100104 |
Method SERVICE_STOP Signature
Method SERVICE_STOP on class CL_RCC_SERVICE_PROFILE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | RCCF Service Exceptions | 20100104 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 702 |