From 505beb4ebd1c3d4ecd2eac627cacd424658e5527 Mon Sep 17 00:00:00 2001 From: Dombrowski Date: Thu, 12 Dec 2024 16:32:24 +0100 Subject: [PATCH] Applied ABAP Cleaner Prfile to v1 again --- .../uiad/type/zif_aff_uiad_v1.intf.abap | 366 +++++++++--------- 1 file changed, 183 insertions(+), 183 deletions(-) diff --git a/file-formats/uiad/type/zif_aff_uiad_v1.intf.abap b/file-formats/uiad/type/zif_aff_uiad_v1.intf.abap index b1b83ffac..d62fb1308 100644 --- a/file-formats/uiad/type/zif_aff_uiad_v1.intf.abap +++ b/file-formats/uiad/type/zif_aff_uiad_v1.intf.abap @@ -1,627 +1,627 @@ -interface zif_aff_uiad_v1 - public. +INTERFACE zif_aff_uiad_v1 + PUBLIC. - types: + TYPES: "!

Header

"! The header for an ABAP main object (without source code) with a description of 255 characters - begin of ty_header, + BEGIN OF ty_header, "!

Description

"! Description of the ABAP object "! $required - description type c length 255, + description TYPE c LENGTH 255, "! $required - original_language type zif_aff_types_v1=>ty_original_language, + original_language TYPE zif_aff_types_v1=>ty_original_language, - abap_language_version type zif_aff_types_v1=>ty_abap_language_version, - end of ty_header. + abap_language_version TYPE zif_aff_types_v1=>ty_abap_language_version, + END OF ty_header. "!

Application Type

"! LADI application type "! $values {@link zif_aff_uiad_v1.data:co_app_type} "! $default {@link zif_aff_uiad_v1.data:co_app_type.ui5} - types ty_app_type type c length 1. + TYPES ty_app_type TYPE c LENGTH 1. - constants: + CONSTANTS: "!

Application Type

"! LADI application type - begin of co_app_type, + BEGIN OF co_app_type, "!

Transaction

"! Transaction - transaction type ty_app_type value 'T', + transaction TYPE ty_app_type VALUE 'T', "!

Web Dynpro Application

"! Web Dynpro application - web_dynpro type ty_app_type value 'W', + web_dynpro TYPE ty_app_type VALUE 'W', "!

Web Client UI Application

"! Web Client UI application - web_client type ty_app_type value 'C', + web_client TYPE ty_app_type VALUE 'C', "!

SAPUI5 Fiori Application

"! SAPUI5 Fiori application - ui5 type ty_app_type value 'U', + ui5 TYPE ty_app_type VALUE 'U', "!

SAPUI5 Fiori Application on SAP BTP (Deprecated)

"! SAPUI5 Fiori application on SAP BTP (deprecated) - legacy_ui5 type ty_app_type value 'S', + legacy_ui5 TYPE ty_app_type VALUE 'S', "!

URL Application

"! URL application - url type ty_app_type value 'R', + url TYPE ty_app_type VALUE 'R', "!

Tile Only

"! Tile only - tile_only type ty_app_type value 'O', + tile_only TYPE ty_app_type VALUE 'O', "!

URL Template

"! URL template - url_template type ty_app_type value 'G', + url_template TYPE ty_app_type VALUE 'G', - end of co_app_type. + END OF co_app_type. - types: + TYPES: "!

General Information

"! General information - begin of ty_general_information, + BEGIN OF ty_general_information, "!

Application Type

"! Application type "! $required - app_type type ty_app_type, + app_type TYPE ty_app_type, "!

Technical Catalog

"! Technical catalog "! $required - catalog_id type c length 40, + catalog_id TYPE c LENGTH 40, "!

SAP Fiori ID

"! SAP Fiori ID - fiori_id type c length 20, + fiori_id TYPE c LENGTH 20, "!

Transaction Code

"! Transaction code - transaction type c length 20, + transaction TYPE c LENGTH 20, "!

Target Mapping Information

"! Target mapping information - information type c length 255, + information TYPE c LENGTH 255, "!

Application Component (ACH)

"! Application component (ACH) - support_component type c length 24, + support_component TYPE c LENGTH 24, "!

Suppress Tiles

"! Suppress tiles - suppress_tiles type abap_bool, + suppress_tiles TYPE abap_bool, - end of ty_general_information. + END OF ty_general_information. - types: + TYPES: "!

SAPUI5 Fiori Application Information

"! SAPUI5 Fiori application information - begin of ty_app_details_ui5, + BEGIN OF ty_app_details_ui5, "!

SAPUI5 Component ID

"! SAPUI5 Component ID "! $required - app_id type c length 70, + app_id TYPE c LENGTH 70, "!

ICF Path

"! ICF path - icf_path type string, + icf_path TYPE string, - end of ty_app_details_ui5. + END OF ty_app_details_ui5. "! Web Dynpro integration mode "! $values {@link zif_aff_uiad_v1.data:co_web_dynpro_integration_mode} "! $default {@link zif_aff_uiad_v1.data:co_web_dynpro_integration_mode.system_default} - types ty_web_dynpro_integration_mode type c length 1. + TYPES ty_web_dynpro_integration_mode TYPE c LENGTH 1. - constants: + CONSTANTS: "!

Web Dynpro Integration Mode

"! Web Dynpro integration mode - begin of co_web_dynpro_integration_mode, + BEGIN OF co_web_dynpro_integration_mode, "!

System Default

"! System default - system_default type ty_web_dynpro_integration_mode value ' ', + system_default TYPE ty_web_dynpro_integration_mode VALUE ' ', "!

Direct

"! Direct - direct type ty_web_dynpro_integration_mode value 'D', + direct TYPE ty_web_dynpro_integration_mode VALUE 'D', "!

Compatible

"! Compatible - compatible type ty_web_dynpro_integration_mode value 'C', + compatible TYPE ty_web_dynpro_integration_mode VALUE 'C', - end of co_web_dynpro_integration_mode. + END OF co_web_dynpro_integration_mode. - types: + TYPES: "!

Web Dynpro Application Inforation

"! Web Dynpro application information - begin of ty_app_details_web_dynpro, + BEGIN OF ty_app_details_web_dynpro, "!

Web Dynpro Application

"! Web Dynpro application "! $required - app_id type c length 30, + app_id TYPE c LENGTH 30, "!

Application Configuration

"! Application configuration - config_id type c length 32, + config_id TYPE c LENGTH 32, "!

Flavor ID

"! Flavor ID (deprecated) - flavor_id type c length 32, + flavor_id TYPE c LENGTH 32, "!

Integration Mode

"! Integration mode (deprecated) - integration_mode type ty_web_dynpro_integration_mode, + integration_mode TYPE ty_web_dynpro_integration_mode, "!

Compatibility Mode

"! Compatibility mode (deprecated) - compatibility_mode type abap_bool, + compatibility_mode TYPE abap_bool, - end of ty_app_details_web_dynpro. + END OF ty_app_details_web_dynpro. - types: + TYPES: "!

Web Client Application Information

"! Web Client application information - begin of ty_app_details_web_client, + BEGIN OF ty_app_details_web_client, "!

Target ID

"! Target ID "! $required - target_id type c length 10, + target_id TYPE c LENGTH 10, - end of ty_app_details_web_client. + END OF ty_app_details_web_client. - types: + TYPES: "!

URL Template Parameter

"! URL template parameter - begin of ty_url_template_parameter, + BEGIN OF ty_url_template_parameter, "!

Name

"! Parameter name "! $required - name type string, + name TYPE string, "!

Value

"! Parameter value - value type string, + value TYPE string, - end of ty_url_template_parameter, + END OF ty_url_template_parameter, - ty_url_template_parameters type standard table of ty_url_template_parameter with default key. + ty_url_template_parameters TYPE STANDARD TABLE OF ty_url_template_parameter WITH DEFAULT KEY. - types: + TYPES: "!

URL Template Application Information

"! URL template application information - begin of ty_app_details_url_template, + BEGIN OF ty_app_details_url_template, "!

URL Template

"! URL template "! $required - template_id type c length 32, + template_id TYPE c LENGTH 32, "!

URL Template Parameters

"! URL template parameters - parameters type ty_url_template_parameters, + parameters TYPE ty_url_template_parameters, - end of ty_app_details_url_template. + END OF ty_app_details_url_template. "!

Filter Type

"! Type of the filter value "! $values {@link zif_aff_uiad_v1.data:co_filter_type} "! $default {@link zif_aff_uiad_v1.data:co_filter_type.plain} - types ty_filter_type type c length 1. + TYPES ty_filter_type TYPE c LENGTH 1. - constants: + CONSTANTS: "!

Filter Type

"! Type of the filter value - begin of co_filter_type, + BEGIN OF co_filter_type, "!

Plain

"! The filter value is used as is - plain type ty_filter_type value ' ', + plain TYPE ty_filter_type VALUE ' ', "!

Regex

"! The filter value is used as a regular expression - regex type ty_filter_type value 'R', + regex TYPE ty_filter_type VALUE 'R', - end of co_filter_type. + END OF co_filter_type. - types: + TYPES: "!

Navigation Parameter

"! Navigation parameter - begin of ty_parameter_item, + BEGIN OF ty_parameter_item, "!

Parameter Name

"! Parameter name "! $required - name type string, + name TYPE string, "!

Parameter in Target Application

"! Parameter in target application - rename_to type string, + rename_to TYPE string, "!

Default Value

"! Default value - default_value type string, + default_value TYPE string, "!

Filter Value

"! Filter value - filter_value type string, + filter_value TYPE string, "!

Filter Type

"! Filter type - filter_type type ty_filter_type, + filter_type TYPE ty_filter_type, "!

Required

"! Whether the parameter is required - required type abap_bool, + required TYPE abap_bool, - end of ty_parameter_item, + END OF ty_parameter_item, - ty_parameter_items type standard table of ty_parameter_item with default key. + ty_parameter_items TYPE STANDARD TABLE OF ty_parameter_item WITH DEFAULT KEY. "!

Additional Parameter Handling

"! How additional parameters are handled "! $values {@link zif_aff_uiad_v1.data:co_additional_param_handling} "! $default {@link zif_aff_uiad_v1.data:co_additional_param_handling.allowed} - types ty_additional_param_handling type c length 1. + TYPES ty_additional_param_handling TYPE c LENGTH 1. - constants: + CONSTANTS: "!

Additional Parameter Handling

"! How additional parameters are handled - begin of co_additional_param_handling, + BEGIN OF co_additional_param_handling, "!

Allowed

"! Additional parameters are allowed - allowed type ty_additional_param_handling value 'A', + allowed TYPE ty_additional_param_handling VALUE 'A', "!

Ignored

"! Additional parameters are ignored - ignored type ty_additional_param_handling value 'I', + ignored TYPE ty_additional_param_handling VALUE 'I', "!

Not Allowed

"! Additional parameters are not allowed - not_allowed type ty_additional_param_handling value 'N', + not_allowed TYPE ty_additional_param_handling VALUE 'N', - end of co_additional_param_handling. + END OF co_additional_param_handling. - types: + TYPES: "!

Navigation Information

"! Navigation information - begin of ty_navigation, + BEGIN OF ty_navigation, "!

Target Mapping ID

"! Target mapping ID "! $required - target_mapping_id type c length 50, + target_mapping_id TYPE c LENGTH 50, "!

Semantic Object

"! Semantic object of the target mapping "! $required - semantic_object type c length 30, + semantic_object TYPE c LENGTH 30, "!

Action

"! Action of the target mapping "! $required - action type c length 60, + action TYPE c LENGTH 60, "!

Target URL

"! Target URL used for apps of type 'Tile Only' and 'URL Application' - target_url type string, + target_url TYPE string, "!

System Alias

"! System alias - system_alias type c length 32, + system_alias TYPE c LENGTH 32, "!

Desktop

"! Desktop is supported as device type - desktop type abap_bool, + desktop TYPE abap_bool, "!

Tablet

"! Tablet is supported as device type - tablet type abap_bool, + tablet TYPE abap_bool, "!

Phone

"! Phone is supported as device type - phone type abap_bool, + phone TYPE abap_bool, "!

Navigation Parameters

"! Navigation parameters of the target mapping - parameters type ty_parameter_items, + parameters TYPE ty_parameter_items, "!

Additional Parameter Handling

"! How additional parameters are handled - additional_parameter_handling type ty_additional_param_handling, + additional_parameter_handling TYPE ty_additional_param_handling, - end of ty_navigation. + END OF ty_navigation. "!

Tile Type

"! Tile type "! $values {@link zif_aff_uiad_v1.data:co_tile_type} "! $default {@link zif_aff_uiad_v1.data:co_tile_type.static} - types ty_tile_type type c length 1. + TYPES ty_tile_type TYPE c LENGTH 1. - constants: + CONSTANTS: "!

Tile Type

"! Tile type - begin of co_tile_type, + BEGIN OF co_tile_type, "!

Static

"! Static tile - static type ty_tile_type value 'S', + static TYPE ty_tile_type VALUE 'S', "!

Dynamic

"! Dynamic tile - dynamic type ty_tile_type value 'D', + dynamic TYPE ty_tile_type VALUE 'D', "!

Custom

"! Custom tile - custom type ty_tile_type value 'C', + custom TYPE ty_tile_type VALUE 'C', - end of co_tile_type. + END OF co_tile_type. - types: + TYPES: "!

Dynamic Tile Details

"! Dynamic tile details - begin of ty_dynamic_tile_details, + BEGIN OF ty_dynamic_tile_details, "!

Service URL

"! Service URL - service_base_url type string, + service_base_url TYPE string, "!

Service Path

"! Service path - service_path type string, + service_path TYPE string, "!

Refresh Interval

"! Duration until the tile is refreshed - refresh_interval type i, + refresh_interval TYPE i, "!

Number Unit

"! Number unit - number_unit type string, + number_unit TYPE string, - end of ty_dynamic_tile_details. + END OF ty_dynamic_tile_details. - types: + TYPES: "!

Tile Navigation Parameter

"! Tile navigation parameter - begin of ty_tile_navigation_parameter, + BEGIN OF ty_tile_navigation_parameter, "!

Name

"! Parameter name "! $required - name type string, + name TYPE string, "!

Value

"! Parameter value - value type string, + value TYPE string, - end of ty_tile_navigation_parameter, + END OF ty_tile_navigation_parameter, - ty_tile_navigation_parameters type standard table of ty_tile_navigation_parameter with default key. + ty_tile_navigation_parameters TYPE STANDARD TABLE OF ty_tile_navigation_parameter WITH DEFAULT KEY. - types: + TYPES: "!

Standard Tile Details

"! Standard tile details - begin of ty_standard_tile_details, + BEGIN OF ty_standard_tile_details, "!

Reuse Text From Application

"! Reuse text defined as part of the app - reuse_text_from_app type abap_bool, + reuse_text_from_app TYPE abap_bool, "!

Title

"! Tile title "! $required - title type c length 255, + title TYPE c LENGTH 255, "!

Subtitle

"! Tile subtitle - subtitle type c length 255, + subtitle TYPE c LENGTH 255, "!

Information

"! Tile information - information type c length 255, + information TYPE c LENGTH 255, "!

Keywords

"! Tile keywords - keywords type c length 255, + keywords TYPE c LENGTH 255, "!

Icon

"! Tile icon - icon type string, + icon TYPE string, "!

Dynamic Tile Details

"! Dynamic tile details - dynamic type ty_dynamic_tile_details, + dynamic TYPE ty_dynamic_tile_details, "!

Tile Navigation Parameters

"! Tile navigation parameters - tile_navigation_parameters type ty_tile_navigation_parameters, + tile_navigation_parameters TYPE ty_tile_navigation_parameters, - end of ty_standard_tile_details. + END OF ty_standard_tile_details. - types: + TYPES: "!

CHIP Bag Property

"! Property of a CHIP bag - begin of ty_chip_bag_property, + BEGIN OF ty_chip_bag_property, "!

Bag ID

"! Bag ID "! $required - bag_id type c length 100, + bag_id TYPE c LENGTH 100, "!

Name

"! Property name "! $required - name type c length 100, + name TYPE c LENGTH 100, "!

Value

"! Property value - value type string, + value TYPE string, "!

Translatable

"! Property is translatable - translatable type abap_bool, + translatable TYPE abap_bool, - end of ty_chip_bag_property, + END OF ty_chip_bag_property, - ty_chip_bag_properties type standard table of ty_chip_bag_property with default key. + ty_chip_bag_properties TYPE STANDARD TABLE OF ty_chip_bag_property WITH DEFAULT KEY. - types: + TYPES: "!

Custom Tile Details

"! CHIP based Custom tile details - begin of ty_custom_tile_details, + BEGIN OF ty_custom_tile_details, "!

Base CHIP

"! Base CHIP - base_chip_id type c length 255, + base_chip_id TYPE c LENGTH 255, "!

Configuration

"! Configuration string of the CHIP - configuration type string, + configuration TYPE string, "!

Bag Properties

"! These Bags are available in the Javascript Frontend via the CHIP API "bag" Contract - bag_properties type ty_chip_bag_properties, + bag_properties TYPE ty_chip_bag_properties, - end of ty_custom_tile_details. + END OF ty_custom_tile_details. - types: + TYPES: "!

Tile Details

"! Details of a tile - begin of ty_tile, + BEGIN OF ty_tile, "!

ID

"! Tile ID "! $required - id type c length 50, + id TYPE c LENGTH 50, "!

Tile Type

"! Tile type "! $required - tile_type type ty_tile_type, + tile_type TYPE ty_tile_type, "!

Is Default Tile

"! Tile is chosen by default - is_default type abap_bool, + is_default TYPE abap_bool, "!

Is Legacy Tile

"! Tile is stored as legacy tile - is_legacy type abap_bool, + is_legacy TYPE abap_bool, "!

Standard Details

"! Standard tile details - standard type ty_standard_tile_details, + standard TYPE ty_standard_tile_details, "!

Custom Details

"! Custom tile details - custom type ty_custom_tile_details, + custom TYPE ty_custom_tile_details, - end of ty_tile, + END OF ty_tile, - ty_tiles type standard table of ty_tile with default key. + ty_tiles TYPE STANDARD TABLE OF ty_tile WITH DEFAULT KEY. "!

Life Cycle Deprecation Status

"! Life cycle deprecation status "! $values {@link zif_aff_uiad_v1.data:co_life_cycle_status} "! $default {@link zif_aff_uiad_v1.data:co_life_cycle_status.active} - types ty_life_cycle_status type c length 1. + TYPES ty_life_cycle_status TYPE c LENGTH 1. - constants: + CONSTANTS: "!

Life Cycle Status

"! Life cycle deprecation status - begin of co_life_cycle_status, + BEGIN OF co_life_cycle_status, "!

Active

"! LADI is active - active type ty_life_cycle_status value ' ', + active TYPE ty_life_cycle_status VALUE ' ', "!

Deprecated

"! LADI is deprecated and should no longer be used - deprecated type ty_life_cycle_status value 'D', + deprecated TYPE ty_life_cycle_status VALUE 'D', "!

Obsolete

"! LADI is obsolete and must no longer be used - obsolete type ty_life_cycle_status value 'O', + obsolete TYPE ty_life_cycle_status VALUE 'O', - end of co_life_cycle_status. + END OF co_life_cycle_status. - types: + TYPES: "!

Life Cycle

"! Life cycle - begin of ty_life_cycle, + BEGIN OF ty_life_cycle, "!

Status

"! Life cycle status - status type ty_life_cycle_status, + status TYPE ty_life_cycle_status, "!

Successor

"! LADI of the successor application - successor type c length 32, + successor TYPE c LENGTH 32, - end of ty_life_cycle. + END OF ty_life_cycle. - types: + TYPES: "!

LADI

"! Launchpad application descriptor item (LADI) - begin of ty_main, + BEGIN OF ty_main, "!

Format Version

"! Format version "! $required - format_version type zif_aff_types_v1=>ty_format_version, + format_version TYPE zif_aff_types_v1=>ty_format_version, "!

Header

"! Header "! $required - header type ty_header, + header TYPE ty_header, "!

General Information

"! General information "! $required - general_information type ty_general_information, + general_information TYPE ty_general_information, "!

SAPUI5 Application Information

"! SAPUI5 application information - ui5_app_details type ty_app_details_ui5, + ui5_app_details TYPE ty_app_details_ui5, "!

Web Dynpro Application Information

"! Web Dynpro application information - web_dynpro_app_details type ty_app_details_web_dynpro, + web_dynpro_app_details TYPE ty_app_details_web_dynpro, "!

Web Client Application Information

"! Web Client application information - web_client_app_details type ty_app_details_web_client, + web_client_app_details TYPE ty_app_details_web_client, "!

URL Template Application Information

"! URL Template application information - url_template_app_details type ty_app_details_url_template, + url_template_app_details TYPE ty_app_details_url_template, "!

Navigation Information

"! Navigation information "! $required - navigation type ty_navigation, + navigation TYPE ty_navigation, "!

Tiles

"! Tiles "! $required - tiles type ty_tiles, + tiles TYPE ty_tiles, "!

Life Cycle

"! Life cycle - life_cycle type ty_life_cycle, + life_cycle TYPE ty_life_cycle, - end of ty_main. + END OF ty_main. - constants co_format_version type zif_aff_types_v1=>ty_format_version value '1'. + CONSTANTS co_format_version TYPE zif_aff_types_v1=>ty_format_version VALUE '1'. -endinterface. +ENDINTERFACE.