upper case interfaces (#662)

* upper case interfaces

* add some naming conventions
This commit is contained in:
Lars Hvam 2020-04-26 21:07:54 +02:00 committed by GitHub
parent 49d78bfe35
commit 0de59b65c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 223 additions and 202 deletions

View File

@ -67,7 +67,28 @@
"msag_consistency": true, "msag_consistency": true,
"newline_between_methods": false, "newline_between_methods": false,
"no_public_attributes": false, "no_public_attributes": false,
"object_naming": false, "object_naming": {
"patternKind": "required",
"ignoreNames": [],
"ignorePatterns": [],
"clas": "^ZC(L|X)\\_EXCEL",
"intf": "^ZIF\\_EXCEL",
"prog": "^Z",
"fugr": "^Z",
"tabl": "^ZEXCEL",
"ttyp": "^ZEXCEL",
"dtel": "^ZEXCEL",
"doma": "^Z",
"msag": "^Z",
"tran": "^Z",
"enqu": "^EZ",
"auth": "^Z",
"pinf": "^Z",
"idoc": "^Z",
"xslt": "^Z",
"ssfo": "^Z",
"ssst": "^Z"
},
"prefer_returning_to_exporting": false, "prefer_returning_to_exporting": false,
"preferred_compare_operator": false, "preferred_compare_operator": false,
"release_idoc": false, "release_idoc": false,

View File

@ -1,24 +1,24 @@
interface ZIF_EXCEL_BOOK_PROPERTIES INTERFACE zif_excel_book_properties
public . PUBLIC .
data CREATOR type ZEXCEL_CREATOR . DATA creator TYPE zexcel_creator .
data LASTMODIFIEDBY type ZEXCEL_CREATOR . DATA lastmodifiedby TYPE zexcel_creator .
data CREATED type TIMESTAMPL . DATA created TYPE timestampl .
data MODIFIED type TIMESTAMPL . DATA modified TYPE timestampl .
data TITLE type ZEXCEL_TITLE . DATA title TYPE zexcel_title .
data SUBJECT type ZEXCEL_SUBJECT . DATA subject TYPE zexcel_subject .
data DESCRIPTION type ZEXCEL_DESCRIPTION . DATA description TYPE zexcel_description .
data KEYWORDS type ZEXCEL_KEYWORDS . DATA keywords TYPE zexcel_keywords .
data CATEGORY type ZEXCEL_CATEGORY . DATA category TYPE zexcel_category .
data COMPANY type ZEXCEL_COMPANY . DATA company TYPE zexcel_company .
data APPLICATION type ZEXCEL_APPLICATION . DATA application TYPE zexcel_application .
data DOCSECURITY type ZEXCEL_DOCSECURITY . DATA docsecurity TYPE zexcel_docsecurity .
data SCALECROP type ZEXCEL_SCALECROP . DATA scalecrop TYPE zexcel_scalecrop .
data LINKSUPTODATE type FLAG . DATA linksuptodate TYPE flag .
data SHAREDDOC type FLAG . DATA shareddoc TYPE flag .
data HYPERLINKSCHANGED type FLAG . DATA hyperlinkschanged TYPE flag .
data APPVERSION type ZEXCEL_APPVERSION . DATA appversion TYPE zexcel_appversion .
methods INITIALIZE . METHODS initialize .
endinterface. ENDINTERFACE.

View File

@ -1,17 +1,17 @@
interface ZIF_EXCEL_BOOK_PROTECTION INTERFACE zif_excel_book_protection
public . PUBLIC .
constants C_LOCKED type ZEXCEL_BOOK_PROTECTION value '1'. "#EC NOTEXT CONSTANTS c_locked TYPE zexcel_book_protection VALUE '1'. "#EC NOTEXT
constants C_PROTECTED type ZEXCEL_BOOK_PROTECTION value 'X'. "#EC NOTEXT CONSTANTS c_protected TYPE zexcel_book_protection VALUE 'X'. "#EC NOTEXT
constants C_UNLOCKED type ZEXCEL_BOOK_PROTECTION value '0'. "#EC NOTEXT CONSTANTS c_unlocked TYPE zexcel_book_protection VALUE '0'. "#EC NOTEXT
constants C_UNPROTECTED type ZEXCEL_BOOK_PROTECTION value ''. "#EC NOTEXT CONSTANTS c_unprotected TYPE zexcel_book_protection VALUE ''. "#EC NOTEXT
data LOCKREVISION type ZEXCEL_BOOK_PROTECTION . DATA lockrevision TYPE zexcel_book_protection .
data LOCKSTRUCTURE type ZEXCEL_BOOK_PROTECTION . DATA lockstructure TYPE zexcel_book_protection .
data LOCKWINDOWS type ZEXCEL_BOOK_PROTECTION . DATA lockwindows TYPE zexcel_book_protection .
data PROTECTED type ZEXCEL_BOOK_PROTECTION . DATA protected TYPE zexcel_book_protection .
data REVISIONSPASSWORD type ZEXCEL_AES_PASSWORD . DATA revisionspassword TYPE zexcel_aes_password .
data WORKBOOKPASSWORD type ZEXCEL_AES_PASSWORD . DATA workbookpassword TYPE zexcel_aes_password .
methods INITIALIZE . METHODS initialize .
endinterface. ENDINTERFACE.

View File

@ -1,18 +1,18 @@
interface ZIF_EXCEL_BOOK_VBA_PROJECT INTERFACE zif_excel_book_vba_project
public . PUBLIC .
data VBAPROJECT type XSTRING read-only . DATA vbaproject TYPE xstring READ-ONLY .
data CODENAME type STRING read-only . DATA codename TYPE string READ-ONLY .
data CODENAME_PR type STRING read-only . DATA codename_pr TYPE string READ-ONLY .
methods SET_VBAPROJECT METHODS set_vbaproject
importing IMPORTING
!IP_VBAPROJECT type XSTRING . !ip_vbaproject TYPE xstring .
methods SET_CODENAME METHODS set_codename
importing IMPORTING
!IP_CODENAME type STRING . !ip_codename TYPE string .
methods SET_CODENAME_PR METHODS set_codename_pr
importing IMPORTING
!IP_CODENAME_PR type STRING . !ip_codename_pr TYPE string .
endinterface. ENDINTERFACE.

View File

@ -1,23 +1,23 @@
interface ZIF_EXCEL_CONVERTER INTERFACE zif_excel_converter
public . PUBLIC .
methods CAN_CONVERT_OBJECT METHODS can_convert_object
importing IMPORTING
!IO_OBJECT type ref to OBJECT !io_object TYPE REF TO object
raising RAISING
ZCX_EXCEL . zcx_excel .
methods CREATE_FIELDCATALOG METHODS create_fieldcatalog
importing IMPORTING
!IS_OPTION type ZEXCEL_S_CONVERTER_OPTION !is_option TYPE zexcel_s_converter_option
!IO_OBJECT type ref to OBJECT !io_object TYPE REF TO object
!IT_TABLE type STANDARD TABLE !it_table TYPE STANDARD TABLE
exporting EXPORTING
!ES_LAYOUT type ZEXCEL_S_CONVERTER_LAYO !es_layout TYPE zexcel_s_converter_layo
!ET_FIELDCATALOG type ZEXCEL_T_CONVERTER_FCAT !et_fieldcatalog TYPE zexcel_t_converter_fcat
!EO_TABLE type ref to DATA !eo_table TYPE REF TO data
!ET_COLORS type ZEXCEL_T_CONVERTER_COL !et_colors TYPE zexcel_t_converter_col
!ET_FILTER type ZEXCEL_T_CONVERTER_FIL !et_filter TYPE zexcel_t_converter_fil
raising RAISING
ZCX_EXCEL . zcx_excel .
endinterface. ENDINTERFACE.

View File

@ -1,7 +1,7 @@
interface ZIF_EXCEL_CUSTOMUI_ELEMENT INTERFACE zif_excel_customui_element
public . PUBLIC .
data ID type STRING . DATA id TYPE string .
data LABEL type STRING . DATA label TYPE string .
endinterface. ENDINTERFACE.

View File

@ -1,24 +1,24 @@
interface ZIF_EXCEL_READER INTERFACE zif_excel_reader
public . PUBLIC .
methods LOAD_FILE METHODS load_file
importing IMPORTING
!I_FILENAME type CSEQUENCE !i_filename TYPE csequence
!I_USE_ALTERNATE_ZIP type SEOCLSNAME default SPACE !i_use_alternate_zip TYPE seoclsname DEFAULT space
!I_FROM_APPLSERVER type SYBATCH default SY-BATCH !i_from_applserver TYPE sybatch DEFAULT sy-batch
!IV_ZCL_EXCEL_CLASSNAME type CLIKE optional !iv_zcl_excel_classname TYPE clike OPTIONAL
returning RETURNING
value(R_EXCEL) type ref to ZCL_EXCEL VALUE(r_excel) TYPE REF TO zcl_excel
raising RAISING
ZCX_EXCEL . zcx_excel .
methods LOAD METHODS load
importing IMPORTING
!I_EXCEL2007 type XSTRING !i_excel2007 TYPE xstring
!I_USE_ALTERNATE_ZIP type SEOCLSNAME default SPACE !i_use_alternate_zip TYPE seoclsname DEFAULT space
!IV_ZCL_EXCEL_CLASSNAME type CLIKE optional !iv_zcl_excel_classname TYPE clike OPTIONAL
returning RETURNING
value(R_EXCEL) type ref to ZCL_EXCEL VALUE(r_excel) TYPE REF TO zcl_excel
raising RAISING
ZCX_EXCEL . zcx_excel .
endinterface. ENDINTERFACE.

View File

@ -1,29 +1,29 @@
interface ZIF_EXCEL_SHEET_PRINTSETTINGS INTERFACE zif_excel_sheet_printsettings
public . PUBLIC .
constants GCV_PRINT_TITLE_NAME type STRING value '_xlnm.Print_Titles'. "#EC NOTEXT CONSTANTS gcv_print_title_name TYPE string VALUE '_xlnm.Print_Titles'. "#EC NOTEXT
methods SET_PRINT_REPEAT_COLUMNS METHODS set_print_repeat_columns
importing IMPORTING
!IV_COLUMNS_FROM type ZEXCEL_CELL_COLUMN_ALPHA !iv_columns_from TYPE zexcel_cell_column_alpha
!IV_COLUMNS_TO type ZEXCEL_CELL_COLUMN_ALPHA !iv_columns_to TYPE zexcel_cell_column_alpha
raising RAISING
ZCX_EXCEL . zcx_excel .
methods SET_PRINT_REPEAT_ROWS METHODS set_print_repeat_rows
importing IMPORTING
!IV_ROWS_FROM type ZEXCEL_CELL_ROW !iv_rows_from TYPE zexcel_cell_row
!IV_ROWS_TO type ZEXCEL_CELL_ROW !iv_rows_to TYPE zexcel_cell_row
raising RAISING
ZCX_EXCEL . zcx_excel .
methods GET_PRINT_REPEAT_COLUMNS METHODS get_print_repeat_columns
exporting EXPORTING
!EV_COLUMNS_FROM type ZEXCEL_CELL_COLUMN_ALPHA !ev_columns_from TYPE zexcel_cell_column_alpha
!EV_COLUMNS_TO type ZEXCEL_CELL_COLUMN_ALPHA . !ev_columns_to TYPE zexcel_cell_column_alpha .
methods GET_PRINT_REPEAT_ROWS METHODS get_print_repeat_rows
exporting EXPORTING
!EV_ROWS_FROM type ZEXCEL_CELL_ROW !ev_rows_from TYPE zexcel_cell_row
!EV_ROWS_TO type ZEXCEL_CELL_ROW . !ev_rows_to TYPE zexcel_cell_row .
methods CLEAR_PRINT_REPEAT_COLUMNS . METHODS clear_print_repeat_columns .
methods CLEAR_PRINT_REPEAT_ROWS . METHODS clear_print_repeat_rows .
endinterface. ENDINTERFACE.

View File

@ -1,34 +1,34 @@
interface ZIF_EXCEL_SHEET_PROPERTIES INTERFACE zif_excel_sheet_properties
public . PUBLIC .
constants C_HIDDEN type ZEXCEL_SHEET_HIDDEN value 'X'. "#EC NOTEXT CONSTANTS c_hidden TYPE zexcel_sheet_hidden VALUE 'X'. "#EC NOTEXT
constants C_VERYHIDDEN type ZEXCEL_SHEET_HIDDEN value '2'. "#EC NOTEXT CONSTANTS c_veryhidden TYPE zexcel_sheet_hidden VALUE '2'. "#EC NOTEXT
constants C_HIDEZERO type ZEXCEL_SHEET_SHOWZEROS value ''. "#EC NOTEXT CONSTANTS c_hidezero TYPE zexcel_sheet_showzeros VALUE ''. "#EC NOTEXT
constants C_SHOWZERO type ZEXCEL_SHEET_SHOWZEROS value 'X'. "#EC NOTEXT CONSTANTS c_showzero TYPE zexcel_sheet_showzeros VALUE 'X'. "#EC NOTEXT
constants C_VISIBLE type ZEXCEL_SHEET_HIDDEN value ''. "#EC NOTEXT CONSTANTS c_visible TYPE zexcel_sheet_hidden VALUE ''. "#EC NOTEXT
data HIDDEN type ZEXCEL_SHEET_HIDDEN . DATA hidden TYPE zexcel_sheet_hidden .
data SHOW_ZEROS type ZEXCEL_SHEET_SHOWZEROS . DATA show_zeros TYPE zexcel_sheet_showzeros .
data STYLE type ZEXCEL_CELL_STYLE . DATA style TYPE zexcel_cell_style .
data ZOOMSCALE type ZEXCEL_SHEET_ZOOMSCALE . DATA zoomscale TYPE zexcel_sheet_zoomscale .
data ZOOMSCALE_NORMAL type ZEXCEL_SHEET_ZOOMSCALE . DATA zoomscale_normal TYPE zexcel_sheet_zoomscale .
data ZOOMSCALE_PAGELAYOUTVIEW type ZEXCEL_SHEET_ZOOMSCALE . DATA zoomscale_pagelayoutview TYPE zexcel_sheet_zoomscale .
data ZOOMSCALE_SHEETLAYOUTVIEW type ZEXCEL_SHEET_ZOOMSCALE . DATA zoomscale_sheetlayoutview TYPE zexcel_sheet_zoomscale .
data SUMMARYBELOW type ZEXCEL_SHEET_SUMMARY . DATA summarybelow TYPE zexcel_sheet_summary .
constants C_BELOW_ON type ZEXCEL_SHEET_SUMMARY value 1. "#EC NOTEXT CONSTANTS c_below_on TYPE zexcel_sheet_summary VALUE 1. "#EC NOTEXT
constants C_BELOW_OFF type ZEXCEL_SHEET_SUMMARY value 0. "#EC NOTEXT CONSTANTS c_below_off TYPE zexcel_sheet_summary VALUE 0. "#EC NOTEXT
data SUMMARYRIGHT type ZEXCEL_SHEET_SUMMARY . DATA summaryright TYPE zexcel_sheet_summary .
constants C_RIGHT_ON type ZEXCEL_SHEET_SUMMARY value 1. "#EC NOTEXT CONSTANTS c_right_on TYPE zexcel_sheet_summary VALUE 1. "#EC NOTEXT
constants C_RIGHT_OFF type ZEXCEL_SHEET_SUMMARY value 0. "#EC NOTEXT CONSTANTS c_right_off TYPE zexcel_sheet_summary VALUE 0. "#EC NOTEXT
data SELECTED type ZEXCEL_SHEET_SELECTED . DATA selected TYPE zexcel_sheet_selected .
constants C_SELECTED type ZEXCEL_SHEET_SELECTED value 'X'. "#EC NOTEXT CONSTANTS c_selected TYPE zexcel_sheet_selected VALUE 'X'. "#EC NOTEXT
data HIDE_COLUMNS_FROM type ZEXCEL_CELL_COLUMN_ALPHA . DATA hide_columns_from TYPE zexcel_cell_column_alpha .
methods INITIALIZE . METHODS initialize .
methods GET_STYLE METHODS get_style
returning RETURNING
value(EP_STYLE) type ZEXCEL_CELL_STYLE . VALUE(ep_style) TYPE zexcel_cell_style .
methods SET_STYLE METHODS set_style
importing IMPORTING
!IP_STYLE type ZEXCEL_CELL_STYLE . !ip_style TYPE zexcel_cell_style .
endinterface. ENDINTERFACE.

View File

@ -1,29 +1,29 @@
interface ZIF_EXCEL_SHEET_PROTECTION INTERFACE zif_excel_sheet_protection
public . PUBLIC .
data AUTO_FILTER type ZEXCEL_SHEET_PROTECTION_BOOL . DATA auto_filter TYPE zexcel_sheet_protection_bool .
constants C_ACTIVE type ZEXCEL_SHEET_PROTECTION_BOOL value '1'. "#EC NOTEXT CONSTANTS c_active TYPE zexcel_sheet_protection_bool VALUE '1'. "#EC NOTEXT
constants C_NOACTIVE type ZEXCEL_SHEET_PROTECTION_BOOL value '0'. "#EC NOTEXT CONSTANTS c_noactive TYPE zexcel_sheet_protection_bool VALUE '0'. "#EC NOTEXT
constants C_PROTECTED type ZEXCEL_SHEET_PROTECTION value 'X'. "#EC NOTEXT CONSTANTS c_protected TYPE zexcel_sheet_protection VALUE 'X'. "#EC NOTEXT
constants C_UNPROTECTED type ZEXCEL_SHEET_PROTECTION value ''. "#EC NOTEXT CONSTANTS c_unprotected TYPE zexcel_sheet_protection VALUE ''. "#EC NOTEXT
data DELETE_COLUMNS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA delete_columns TYPE zexcel_sheet_protection_bool .
data DELETE_ROWS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA delete_rows TYPE zexcel_sheet_protection_bool .
data FORMAT_CELLS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA format_cells TYPE zexcel_sheet_protection_bool .
data FORMAT_COLUMNS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA format_columns TYPE zexcel_sheet_protection_bool .
data FORMAT_ROWS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA format_rows TYPE zexcel_sheet_protection_bool .
data INSERT_COLUMNS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA insert_columns TYPE zexcel_sheet_protection_bool .
data INSERT_HYPERLINKS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA insert_hyperlinks TYPE zexcel_sheet_protection_bool .
data INSERT_ROWS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA insert_rows TYPE zexcel_sheet_protection_bool .
data OBJECTS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA objects TYPE zexcel_sheet_protection_bool .
data PASSWORD type ZEXCEL_AES_PASSWORD . DATA password TYPE zexcel_aes_password .
data PIVOT_TABLES type ZEXCEL_SHEET_PROTECTION_BOOL . DATA pivot_tables TYPE zexcel_sheet_protection_bool .
data PROTECTED type ZEXCEL_SHEET_PROTECTION . DATA protected TYPE zexcel_sheet_protection .
data SCENARIOS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA scenarios TYPE zexcel_sheet_protection_bool .
data SELECT_LOCKED_CELLS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA select_locked_cells TYPE zexcel_sheet_protection_bool .
data SELECT_UNLOCKED_CELLS type ZEXCEL_SHEET_PROTECTION_BOOL . DATA select_unlocked_cells TYPE zexcel_sheet_protection_bool .
data SHEET type ZEXCEL_SHEET_PROTECTION_BOOL . DATA sheet TYPE zexcel_sheet_protection_bool .
data SORT type ZEXCEL_SHEET_PROTECTION_BOOL . DATA sort TYPE zexcel_sheet_protection_bool .
methods INITIALIZE . METHODS initialize .
endinterface. ENDINTERFACE.

View File

@ -1,15 +1,15 @@
interface ZIF_EXCEL_SHEET_VBA_PROJECT INTERFACE zif_excel_sheet_vba_project
public . PUBLIC .
data VBAPROJECT type XSTRING read-only . DATA vbaproject TYPE xstring READ-ONLY .
data CODENAME type STRING read-only . DATA codename TYPE string READ-ONLY .
data CODENAME_PR type STRING read-only . DATA codename_pr TYPE string READ-ONLY .
methods SET_CODENAME METHODS set_codename
importing IMPORTING
!IP_CODENAME type STRING . !ip_codename TYPE string .
methods SET_CODENAME_PR METHODS set_codename_pr
importing IMPORTING
!IP_CODENAME_PR type STRING . !ip_codename_pr TYPE string .
endinterface. ENDINTERFACE.

View File

@ -1,10 +1,10 @@
interface ZIF_EXCEL_WRITER INTERFACE zif_excel_writer
public . PUBLIC .
methods WRITE_FILE METHODS write_file
importing IMPORTING
!IO_EXCEL type ref to ZCL_EXCEL !io_excel TYPE REF TO zcl_excel
returning RETURNING
value(EP_FILE) type XSTRING . VALUE(ep_file) TYPE xstring .
endinterface. ENDINTERFACE.