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,
"newline_between_methods": 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,
"preferred_compare_operator": false,
"release_idoc": false,

View File

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

View File

@ -1,17 +1,17 @@
interface ZIF_EXCEL_BOOK_PROTECTION
public .
INTERFACE zif_excel_book_protection
PUBLIC .
constants C_LOCKED type ZEXCEL_BOOK_PROTECTION value '1'. "#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_UNPROTECTED type ZEXCEL_BOOK_PROTECTION value ''. "#EC NOTEXT
data LOCKREVISION type ZEXCEL_BOOK_PROTECTION .
data LOCKSTRUCTURE type ZEXCEL_BOOK_PROTECTION .
data LOCKWINDOWS type ZEXCEL_BOOK_PROTECTION .
data PROTECTED type ZEXCEL_BOOK_PROTECTION .
data REVISIONSPASSWORD type ZEXCEL_AES_PASSWORD .
data WORKBOOKPASSWORD type ZEXCEL_AES_PASSWORD .
CONSTANTS c_locked TYPE zexcel_book_protection VALUE '1'. "#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_unprotected TYPE zexcel_book_protection VALUE ''. "#EC NOTEXT
DATA lockrevision TYPE zexcel_book_protection .
DATA lockstructure TYPE zexcel_book_protection .
DATA lockwindows TYPE zexcel_book_protection .
DATA protected TYPE zexcel_book_protection .
DATA revisionspassword TYPE zexcel_aes_password .
DATA workbookpassword TYPE zexcel_aes_password .
methods INITIALIZE .
endinterface.
METHODS initialize .
ENDINTERFACE.

View File

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

View File

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

View File

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

View File

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

View File

@ -1,29 +1,29 @@
interface ZIF_EXCEL_SHEET_PRINTSETTINGS
public .
INTERFACE zif_excel_sheet_printsettings
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
importing
!IV_COLUMNS_FROM type ZEXCEL_CELL_COLUMN_ALPHA
!IV_COLUMNS_TO type ZEXCEL_CELL_COLUMN_ALPHA
raising
ZCX_EXCEL .
methods SET_PRINT_REPEAT_ROWS
importing
!IV_ROWS_FROM type ZEXCEL_CELL_ROW
!IV_ROWS_TO type ZEXCEL_CELL_ROW
raising
ZCX_EXCEL .
methods GET_PRINT_REPEAT_COLUMNS
exporting
!EV_COLUMNS_FROM type ZEXCEL_CELL_COLUMN_ALPHA
!EV_COLUMNS_TO type ZEXCEL_CELL_COLUMN_ALPHA .
methods GET_PRINT_REPEAT_ROWS
exporting
!EV_ROWS_FROM type ZEXCEL_CELL_ROW
!EV_ROWS_TO type ZEXCEL_CELL_ROW .
methods CLEAR_PRINT_REPEAT_COLUMNS .
methods CLEAR_PRINT_REPEAT_ROWS .
endinterface.
METHODS set_print_repeat_columns
IMPORTING
!iv_columns_from TYPE zexcel_cell_column_alpha
!iv_columns_to TYPE zexcel_cell_column_alpha
RAISING
zcx_excel .
METHODS set_print_repeat_rows
IMPORTING
!iv_rows_from TYPE zexcel_cell_row
!iv_rows_to TYPE zexcel_cell_row
RAISING
zcx_excel .
METHODS get_print_repeat_columns
EXPORTING
!ev_columns_from TYPE zexcel_cell_column_alpha
!ev_columns_to TYPE zexcel_cell_column_alpha .
METHODS get_print_repeat_rows
EXPORTING
!ev_rows_from TYPE zexcel_cell_row
!ev_rows_to TYPE zexcel_cell_row .
METHODS clear_print_repeat_columns .
METHODS clear_print_repeat_rows .
ENDINTERFACE.

View File

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

View File

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

View File

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

View File

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