SAP ABAP Interface IF_DBPROC_PROXY_UI (Interface for UI)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-DWB-DIC (Application Component) ABAP Dictionary
⤷
SDDBPROC_PROXY (Package) Back-End Functions for Database Procedure Proxy
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_DBPROC_PROXY | Back-End Functions DB Procedure Proxy | 20120117 |
Properties
| Interface | IF_DBPROC_PROXY_UI | |
| Short Description | Interface for UI |
General Data
| Package | SDDBPROC_PROXY | Back-End Functions for Database Procedure Proxy |
| Created | 20120420 | SAP |
| Last changed | 20140121 | 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 | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_DBPROC_PROXY_BASIC_TYPES | Basic Type Definitions for DB Procedure Proxies | 20120420 |
Friends
Interface IF_DBPROC_PROXY_UI has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CF_PARAM_DIRECTION_IN | Instance attribute | Public | Attribute reference (LIKE) | 20120420 | ||||
| 2 | CF_PARAM_DIRECTION_INOUT | Instance attribute | Public | Attribute reference (LIKE) | 20120420 | ||||
| 3 | CF_PARAM_DIRECTION_OUT | Instance attribute | Public | Attribute reference (LIKE) | 20120420 | ||||
| 4 | CF_PARAM_KIND_SCALAR | Instance attribute | Public | Attribute reference (LIKE) | 20120420 | ||||
| 5 | CF_PARAM_KIND_TABLE | Instance attribute | Public | Attribute reference (LIKE) | 20120420 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Activate Proxy | 20120420 | |
| 2 | Instance method | Public | Method | Check Proxy | 20120420 | |
| 3 | Instance method | Public | Method | Initial Creation of a Proxy | 20120420 | |
| 4 | Instance method | Public | Method | Delete Proxy | 20120420 | |
| 5 | Instance method | Public | Method | Check whether proxy exists | 20120420 | |
| 6 | Instance method | Public | Method | Get Technical Name of Proxy | 20120420 | |
| 7 | Instance method | Public | Method | Does interface information match DB procedure? | 20120420 | |
| 8 | Instance method | Public | Method | Read Description | 20120420 | |
| 9 | Instance method | Public | Method | Transport Proxy from DB Procedure | 20120420 | |
| 10 | Instance method | Public | Method | Read Proxy from REPOSRC | 20120420 | |
| 11 | Instance method | Public | Method | Set Changeable Proxy Information to Default | 20120420 | |
| 12 | Instance method | Public | Method | Check Changeable Proxy Information for Consistency | 20120420 | |
| 13 | Instance method | Public | Method | Write Description | 20120420 | |
| 14 | Instance method | Public | Method | Write Proxy to REPOSRC | 20120420 |
Events
Interface IF_DBPROC_PROXY_UI has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_ABAP_NAME | Public | Attribute reference (LIKE) | 20120420 | |
||
| 2 | TY_ABAP_SIMPLE_TYPE_S | Public | Attribute reference (LIKE) | 20120420 | |
||
| 3 | TY_ABAP_SIMPLE_TYPE_UI_S | Public | See coding | 20120420 | begin of ty_abap_simple_type_ui_s,
typ type ty_abap_simple_type_s,
text type string,
end of ty_abap_simple_type_ui_s
|
||
| 4 | TY_ABAP_SIMPLE_TYPE_UI_T | Public | See coding | 20120420 | ty_abap_simple_type_ui_t type STANDARD TABLE OF ty_abap_simple_type_ui_s with DEFAULT KEY
|
||
| 5 | TY_DB_NAME | Public | Attribute reference (LIKE) | 20120420 | |
||
| 6 | TY_DB_SIMPLE_TYPE_S | Public | Attribute reference (LIKE) | 20120420 | |
||
| 7 | TY_DDIC_NAME | Public | Attribute reference (LIKE) | 20120420 | |
||
| 8 | TY_HEADER_UI_S | Public | See coding | 20120420 | begin of ty_header_ui_s,
db_repository_package type ty_db_name, " proc in repository: package
db_repository_proc_name type ty_db_name, " proc in repository: name
db_catalog_schema type ty_db_name, " irrelevant for UI, proc in catalog: schema
db_catalog_proc_name type ty_db_name, " irrelevant for UI, proc in catalog: name
read_only type abap_bool, " DB proc is read-only
interface_pool type ty_abap_name, " name of ABAP interface pool generated for housing the types
end of ty_header_ui_s
|
||
| 9 | TY_MSG_UI_S | Public | See coding | 20120420 | begin of TY_MSG_UI_S,
severity type severity,
parameter type i,
component type i,
context type string,
t100_key type SCX_T100KEY,
text type string,
end of TY_MSG_UI_S
|
||
| 10 | TY_MSG_UI_T | Public | See coding | 20120420 | ty_msg_ui_t type STANDARD TABLE OF ty_msg_ui_s with DEFAULT KEY
|
||
| 11 | TY_PARAM_DIRECTION | Public | Attribute reference (LIKE) | 20120420 | |
||
| 12 | TY_PARAM_KIND | Public | Attribute reference (LIKE) | 20120420 | |
||
| 13 | TY_PARAM_TYPE_UI_S | Public | See coding | 20120420 | begin of ty_param_type_ui_s,
param_position type i, " refers to parameter position in ty_param_ui_s, 1..n
comp_index type i, " 0 for scalar parameters, for table parameters this is the index of the component (1..n)
db_comp_name type ty_db_name, " only for table parameters, name of component in db
abap_comp_name type ty_abap_name, " only for table parameters, name of component in ABAP
abap_comp_name_is_ro type abap_bool, " false => abap_comp_name can be changed in UI
db_type type ty_db_simple_type_s, " irrelevant for UI, primitive type in DB
db_type_text type string, " for UI: text representation of primitive type in DB
abap_type type ty_abap_simple_type_ui_s, " primitive type in ABAP, for UI only field "text" is relevant
abap_type_is_ro type abap_bool, " false => abap_type can be changed in UI
abap_type_selection type ty_abap_simple_type_ui_t, " possible values for abap_type, to be displayed in drop down box
ddic_type type ty_ddic_name, " DDIC type override
ddic_type_is_ro type abap_bool, " false => ddic_type can be changed in UI
end of ty_param_type_ui_s
|
||
| 14 | TY_PARAM_TYPE_UI_T | Public | See coding | 20120420 | ty_param_type_ui_t type standard table of ty_param_type_ui_s WITH KEY param_position comp_index
|
||
| 15 | TY_PARAM_UI_S | Public | See coding | 20120420 | begin of ty_param_ui_s,
position type i, " position of parameter in DB proc interface, 1..n
db_name type ty_db_name, " name of parameter in DB
direction type ty_param_direction, " in, out, inout
kind type ty_param_kind, " scalar or table
db_table_type_schema type ty_db_name, " only for table parameters, schema of parameter type in DB
db_table_type_name type ty_db_name, " only for table parameters, name of parameter type in DB
db_table_type_is_ddic type abap_bool, " only for table parameters, db table type is ddic type
transfer_table_schema type ty_db_name, " irrelevant for UI, only for table parameters, schema of data transfer table for call execution
transfer_table_name type ty_db_name, " irrelevant for UI, only for table parameters, name of data transfer table for call execution
abap_name type ty_abap_name, " name of corresponding actual parameter in the proxy
abap_name_is_ro type abap_bool, " false => abap_name can be changed in UI
ddic_table type ty_ddic_name, " only for table parameters, DDIC table override
ddic_table_is_ro type abap_bool, " false => ddic_table can be changed in UI
end of ty_param_ui_s
|
||
| 16 | TY_PARAM_UI_T | Public | See coding | 20120420 | ty_param_ui_t type standard table of ty_param_ui_s WITH KEY position
|
Method Signatures
Method ACTIVATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | TY_MSG_UI_T | Meldungen | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
Method CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EF_RESULT | Call by reference | Type reference (TYPE) | SEVERITY | SPACE(ok), W, E | 20120420 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | TY_MSG_UI_T | 20120420 | ||||
| 3 | IS_HEADER | Call by reference | Type reference (TYPE) | TY_HEADER_UI_S | 20120420 | ||||
| 4 | IT_PARAMETER | Call by reference | Type reference (TYPE) | TY_PARAM_UI_T | 20120420 | ||||
| 5 | IT_PARAMETER_TYPE | Call by reference | Type reference (TYPE) | TY_PARAM_TYPE_UI_T | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | TY_MSG_UI_T | Meldungen | 20120420 | |||
| 2 | IF_INTERFACE_POOL | Call by reference | Type reference (TYPE) | TY_ABAP_NAME | Name in ABAP | 20120420 | |||
| 3 | IF_LANGU | Call by reference | Type reference (TYPE) | SYLANGU | Sprachenschlüssel der aktuellen Textumgebung | 20120420 | |||
| 4 | IF_PACKAGE | Call by reference | Type reference (TYPE) | DEVCLASS | Paket | 20120420 | |||
| 5 | IF_TRANSPORT_REQ | Call by reference | Type reference (TYPE) | TRKORR | Transportauftrag | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | TY_MSG_UI_T | Meldungen | 20120420 | |||
| 2 | IF_TRANSPORT_REQ | Call by reference | Type reference (TYPE) | TRKORR | Transportauftrag | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
Method EXISTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EF_EXISTS | Value transfer | Type reference (TYPE) | ABAP_BOOL | TRUE: existiert, FALSE: existiert nicht | 20120420 | |||
| 2 | IF_VERSION | Call by reference | Type reference (TYPE) | R3STATE | SPACE | ABAP: Programmstatus (aktiv, gesichert, transportiert...) | 20120420 |
Method EXISTS on Interface IF_DBPROC_PROXY_UI has no exception.
Method GET_INTERNAL_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | INTERNAL_NAME | Value transfer | Type reference (TYPE) | PROGNAME | ABAP-Programmname | 20120420 |
Method GET_INTERNAL_NAME on Interface IF_DBPROC_PROXY_UI has no exception.
Method IS_CONSISTENT_WITH_DB_PROC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_CONSISTENT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20120420 | ||||
| 2 | IS_HEADER | Call by reference | Type reference (TYPE) | TY_HEADER_UI_S | Header Infromationen | 20120420 | |||
| 3 | IT_PARAMETER | Call by reference | Type reference (TYPE) | TY_PARAM_UI_T | Parameter Informationen | 20120420 | |||
| 4 | IT_PARAMETER_TYPE | Call by reference | Type reference (TYPE) | TY_PARAM_TYPE_UI_T | Parameter-Typen | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
Method READ_DESCR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EF_DESCR | Call by reference | Type reference (TYPE) | DDTEXT | Beschreibung | 20120420 | |||
| 2 | EF_LANGU_NOT_MAINTAINED | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20120420 | ||||
| 3 | IF_LANGU | Call by reference | Type reference (TYPE) | SYLANGU | Sprachenschlüssel der aktuellen Textumgebung | 20120420 | |||
| 4 | IF_VERSION | Call by reference | Type reference (TYPE) | R3STATE | ABAP: Programmstatus (aktiv, gesichert, transportiert...) | 20120420 |
Method READ_DESCR on Interface IF_DBPROC_PROXY_UI has no exception.
Method READ_FROM_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DB_PROC_NAME | Call by reference | Type reference (TYPE) | TY_DB_NAME | Name der Prozedur im Repository | 20120420 | |||
| 2 | DB_PROC_PACKAGE | Call by reference | Type reference (TYPE) | TY_DB_NAME | Paket der Prozedur im Repository | 20120420 | |||
| 3 | ES_HEADER | Call by reference | Type reference (TYPE) | TY_HEADER_UI_S | 20120420 | ||||
| 4 | ET_MESSAGE | Call by reference | Type reference (TYPE) | TY_MSG_UI_T | Meldungen | 20120420 | |||
| 5 | ET_PARAMETER | Call by reference | Type reference (TYPE) | TY_PARAM_UI_T | 20120420 | ||||
| 6 | ET_PARAMETER_TYPE | Call by reference | Type reference (TYPE) | TY_PARAM_TYPE_UI_T | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
Method READ_FROM_SOURCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EF_CHANGE_DATE | Call by reference | Type reference (TYPE) | RDIR_UDATE | Änderungsdatum | 20120420 | |||
| 2 | EF_CHANGE_TIME | Call by reference | Type reference (TYPE) | DDTIME | Dictionary: Zeit der letzten Änderung | 20120420 | |||
| 3 | EF_CHANGE_USER | Call by reference | Type reference (TYPE) | UNAM | Name des letzten Änderers | 20120420 | |||
| 4 | EF_CREATE_DATE | Call by reference | Type reference (TYPE) | RDIR_CDATE | Erstellungsdatum | 20120420 | |||
| 5 | EF_CREATE_USER | Call by reference | Type reference (TYPE) | CNAM | Autor | 20120420 | |||
| 6 | EF_VERSION_READ | Call by reference | Type reference (TYPE) | R3STATE | Tatsächlich gelesene Version | 20120420 | |||
| 7 | ES_HEADER | Call by reference | Type reference (TYPE) | TY_HEADER_UI_S | 20120420 | ||||
| 8 | ET_PARAMETER | Call by reference | Type reference (TYPE) | TY_PARAM_UI_T | 20120420 | ||||
| 9 | ET_PARAMETER_TYPE | Call by reference | Type reference (TYPE) | TY_PARAM_TYPE_UI_T | 20120420 | ||||
| 10 | IF_VERSION | Call by reference | Type reference (TYPE) | R3STATE | ABAP: Programmstatus (aktiv, gesichert, transportiert...) | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
Method RESET_TO_DEFAULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_PARAMETER | Call by reference | Type reference (TYPE) | TY_PARAM_UI_T | Parameter | 20120420 | |||
| 2 | CT_PARAMETER_TYPE | Call by reference | Type reference (TYPE) | TY_PARAM_TYPE_UI_T | Parameter-Typen | 20120420 | |||
| 3 | ET_MESSAGE | Call by reference | Type reference (TYPE) | TY_MSG_UI_T | Meldungen | 20120420 |
Method RESET_TO_DEFAULTS on Interface IF_DBPROC_PROXY_UI has no exception.
Method VALIDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_PARAMETER | Call by reference | Type reference (TYPE) | TY_PARAM_UI_T | Parameter | 20120420 | |||
| 2 | CT_PARAMETER_TYPE | Call by reference | Type reference (TYPE) | TY_PARAM_TYPE_UI_T | Parameter-Typen | 20120420 | |||
| 3 | EF_RESULT | Call by reference | Type reference (TYPE) | SEVERITY | Output: Schwere des Fehlers (N/SPACE-Normal, E/F/A-Fehler) | 20120420 | |||
| 4 | ET_MESSAGE | Call by reference | Type reference (TYPE) | TY_MSG_UI_T | Meldungen | 20120420 | |||
| 5 | IF_REFLECT_CHANGES | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Benutzereingaben auswerten | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
Method WRITE_DESCR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IF_DESCR | Call by reference | Type reference (TYPE) | DDTEXT | Erläuternder Kurztext | 20120420 | |||
| 2 | IF_LANGU | Call by reference | Type reference (TYPE) | SYLANGU | Sprachenschlüssel der aktuellen Textumgebung | 20120420 |
Method WRITE_DESCR on Interface IF_DBPROC_PROXY_UI has no exception.
Method WRITE_TO_SOURCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | TY_MSG_UI_T | Meldungen | 20120420 | |||
| 2 | IF_TRANSPORT_REQ | Call by reference | Type reference (TYPE) | TRKORR | Transportauftrag | 20120420 | |||
| 3 | IS_HEADER | Call by reference | Type reference (TYPE) | TY_HEADER_UI_S | 20120420 | ||||
| 4 | IT_PARAMETER | Call by reference | Type reference (TYPE) | TY_PARAM_UI_T | 20120420 | ||||
| 5 | IT_PARAMETER_TYPE | Call by reference | Type reference (TYPE) | TY_PARAM_TYPE_UI_T | 20120420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20120420 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |