SAP ABAP Class /UI2/CL_START_UP_HANDLER (SICF Handler of Start-Up Service)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-INT-BE (Application Component) Backend Enablement
⤷
/UI2/BASIS_SERVICES_START_UP (Package) UI BE: Start-Up of Frontend Shell
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_HTTP_EXTENSION | HTTP Framework (iHTTP) HTTP Request Handler | 20120926 |
Properties
| Class | /UI2/CL_START_UP_HANDLER | |
| Short Description | SICF Handler of Start-Up Service | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /UI2/BASIS_SERVICES_START_UP | UI BE: Start-Up of Frontend Shell |
| Created | 20120926 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 2 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 3 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 4 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_HTTP_EXTENSION | HTTP Framework (iHTTP) HTTP Request Handler | 20120926 |
Friends
Class /UI2/CL_START_UP_HANDLER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | STRING | 'json' | 20130909 | |||
| 2 | Constant | Public | Type reference (TYPE) | STRING | 'xml' | 20130909 | |||
| 3 | Constant | Public | Type reference (TYPE) | STRING | 'false' | 20130909 | |||
| 4 | Constant | Public | See coding | 20130909 | |||||
| 5 | Constant | Protected | Type reference (TYPE) | STRING | 'menu-placeholder' | Menu replacement placeholder | 20130911 | ||
| 6 | Constant | Public | Type reference (TYPE) | STRING | '~path_info' | 20130909 | |||
| 7 | Constant | Public | See coding | 20130909 | |||||
| 8 | Constant | Public | See coding | 20131011 | |||||
| 9 | Constant | Public | See coding | 20131011 | |||||
| 10 | Constant | Public | Type reference (TYPE) | SEOCLSNAME | '/UI2/CL_START_UP_MENU' | 20130909 | |||
| 11 | Constant | Public | Type reference (TYPE) | STRING | 'true' | 20130909 | |||
| 12 | Instance attribute | Public | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130909 | |||
| 13 | Static Attribute | Private | Type reference (TYPE) | T_STRINGS | Allowed form fields | 20130916 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | 20121205 | ||
| 2 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20130916 | |
| 3 | Instance method | Private | Method | Create response body for status code | 20130128 | |
| 4 | Instance method | Public | Method | Erzeuge Antwort in Json format | 20121126 | |
| 5 | Instance method | Public | Method | Request auswerten | 20121126 | |
| 6 | Instance method | Public | Method | Read of boolean form field parameter | 20130909 | |
| 7 | Instance method | Public | Method | 20130909 | ||
| 8 | Instance method | Private | Method | Get NWBC Runtime | 20131011 | |
| 9 | Instance method | Private | Method | Resolves initial target | 20130909 | |
| 10 | Instance method | Private | Method | Set repsonse in case of exception | 20130128 |
Events
Class /UI2/CL_START_UP_HANDLER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_EVAL_REQUEST | Public | See coding | 20130125 | BEGIN OF t_eval_request ,
path_info TYPE string,
unique_id TYPE string,
depth TYPE i,
path TYPE abap_bool,
return_format TYPE string,
compress TYPE abap_bool,
shell_type TYPE string,
END OF t_eval_request
|
||
| 2 | T_SERVICE | Public | See coding | 20140714 | BEGIN OF t_service,
base_url TYPE string,
relative_url TYPE string,
END OF t_service
|
||
| 3 | T_SERVICES | Public | See coding | 20140425 | BEGIN OF t_services,
target_mappings TYPE t_service,
END OF t_services
|
||
| 4 | T_START_UP | Public | See coding | 20130125 | BEGIN OF t_start_up,
client TYPE mandt,
system_info TYPE /ui2/if_nwbc_runtime35=>t_configuration,
services TYPE t_services,
user_info TYPE /ui2/if_nwbc_runtime35=>t_user_info,
user_profile TYPE /ui2/cl_user_profile=>tp_t_user_profile,
initial_target TYPE /ui2/if_edm_mp_interop=>tp_t_nav_target,
is_jam_active TYPE abap_bool,
menu TYPE string,
END OF t_start_up
|
||
| 5 | T_START_UP_AGGR | Public | See coding | 20130909 | BEGIN OF t_start_up_aggr,
client TYPE mandt,
date_format TYPE xudatfm,
email TYPE string,
first_name TYPE string,
full_name TYPE string,
id TYPE string, " user
language TYPE laiso,
language_bcp47 TYPE string,
last_name TYPE string,
menu TYPE string, " menu_info
number_format TYPE xudcpfm, " decimal_notation
rtl TYPE abap_bool,
system TYPE string, " system_id from system info
theme TYPE string,
time_format TYPE xutimefm,
time_zone TYPE tznzone,
welcome_message TYPE string,
user_profile TYPE /ui2/cl_user_profile=>tp_t_user_profile,
is_jam_active TYPE abap_bool,
is_emb_reporting_active TYPE abap_bool,
services TYPE t_services,
initial_target TYPE /ui2/if_edm_mp_interop=>tp_t_nav_target,
END OF t_start_up_aggr
|
||
| 6 | T_STRINGS | Public | See coding | 20130916 | t_strings TYPE SORTED TABLE OF string WITH UNIQUE KEY table_line
|
Method Signatures
Method AGGREGATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_STARTUP_AGGR | Call by reference | Type reference (TYPE) | T_START_UP_AGGR | 20140516 | ||||
| 2 | I_STARTUP | Call by reference | Type reference (TYPE) | T_START_UP | 20121205 |
Method AGGREGATE on class /UI2/CL_START_UP_HANDLER has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class /UI2/CL_START_UP_HANDLER has no parameter.
Method CLASS_CONSTRUCTOR on class /UI2/CL_START_UP_HANDLER has no exception.
Method CREATE_BODY_STATUS_CODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_STATUS_CODE | Call by reference | Type reference (TYPE) | I | 20130128 | ||||
| 2 | IV_STATUS_TEXT | Call by reference | Type reference (TYPE) | STRING | 20130128 | ||||
| 3 | R_BODY_STATUS_CODE | Value transfer | Type reference (TYPE) | STRING | 20130128 |
Method CREATE_BODY_STATUS_CODE on class /UI2/CL_START_UP_HANDLER has no exception.
Method CREATE_RESPONSE_JSON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_START_UP_AGGR | Call by reference | Type reference (TYPE) | T_START_UP_AGGR | 20121205 | ||||
| 2 | I_EVAL_REQUEST | Call by reference | Type reference (TYPE) | T_EVAL_REQUEST | 20130116 | ||||
| 3 | I_MENU_INFO | Call by reference | Type reference (TYPE) | STRING | 20121126 | ||||
| 4 | I_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20121126 |
Method CREATE_RESPONSE_JSON on class /UI2/CL_START_UP_HANDLER has no exception.
Method EVAL_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20121126 | |||
| 2 | R_EVAL_REQUEST | Value transfer | Type reference (TYPE) | T_EVAL_REQUEST | 20121126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | UI2 Exception for data provider | 20121204 |
Method GET_BOOL_FORM_FIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DEFAULT_VALUE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20131011 | |||
| 2 | FF | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20131011 | ||||
| 3 | NAME | Call by reference | Type reference (TYPE) | STRING | Parameter name | 20130909 |
Method GET_BOOL_FORM_FIELD on class /UI2/CL_START_UP_HANDLER has no exception.
Method GET_FILTERED_FORM_FIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACCEPT | Call by reference | Type reference (TYPE) | STRING | 20130909 | ||||
| 2 | DEFAULT | Call by reference | Type reference (TYPE) | ANY | 20130909 | ||||
| 3 | FF | Value transfer | Type reference (TYPE) | STRING | 20130909 | ||||
| 4 | NAME | Call by reference | Type reference (TYPE) | STRING | 20130909 | ||||
| 5 | REJECT | Call by reference | Type reference (TYPE) | STRING | 20130909 | ||||
| 6 | UPPER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130909 |
Method GET_FILTERED_FORM_FIELD on class /UI2/CL_START_UP_HANDLER has no exception.
Method GET_NWBC_RUNTIME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20131011 | |||
| 2 | IV_SHELL_TYPE | Call by reference | Type reference (TYPE) | CSEQUENCE | 20131011 | ||||
| 3 | RO_RUNTIME | Value transfer | Object reference (TYPE REF TO) | /UI2/IF_NWBC_RUNTIME | The NWBC Runtime Interface | 20131011 |
Method GET_NWBC_RUNTIME on class /UI2/CL_START_UP_HANDLER has no exception.
Method RESOLVE_TARGET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_RESPONSE | Call by reference | Type reference (TYPE) | T_START_UP | Resolves initial target, if requested | 20130909 | |||
| 2 | I_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130909 |
Method RESOLVE_TARGET on class /UI2/CL_START_UP_HANDLER has no exception.
Method SET_RESPONSE_EXCEPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_EXC | Call by reference | Object reference (TYPE REF TO) | CX_ROOT | Abstract Superclass for All Global Exceptions | 20130128 | |||
| 2 | I_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Server | 20130128 |
Method SET_RESPONSE_EXCEPTION on class /UI2/CL_START_UP_HANDLER has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |