Package com.hybris.backoffice.excel.exporting

Interface ExcelExportService

  • All Known Implementing Classes:
    DefaultExcelExportService
    public interface ExcelExportService
    Service for exporting data to excel workbook

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.apache.poi.ss.usermodel.Workbook exportData​(java.lang.String typeCode, java.util.List<SelectedAttribute> selectedAttributes)
      Exports data to excel workbook for given type
      org.apache.poi.ss.usermodel.Workbook exportData​(java.util.List<ItemModel> selectedItems, java.util.List<SelectedAttribute> selectedAttributes)
      Exports data to excel workbook
      org.apache.poi.ss.usermodel.Workbook exportTemplate​(java.lang.String typeCode)
      Exports a template excel workbook.

    • Method Detail

      • exportTemplate

        org.apache.poi.ss.usermodel.Workbook exportTemplate​(java.lang.String typeCode)
        Exports a template excel workbook. Its purpose is to provide an empty excel file that a user can fill with data, and then re-import. The template contains sheets for the typeCode and all of it's non-abstract sub-types, with all the metadata (like the available attributes).
        Parameters:
        typeCode - the type for which the template workbook will be created
        Returns:
        the template workbook

      • exportData

        org.apache.poi.ss.usermodel.Workbook exportData​(java.util.List<ItemModel> selectedItems,
                                                java.util.List<SelectedAttribute> selectedAttributes)
        Exports data to excel workbook
        Parameters:
        selectedItems - list of items which will be exported
        selectedAttributes - list of selected attributes which have metadata necessary for reimporting the data
        Returns:
        sheet

      • exportData

        org.apache.poi.ss.usermodel.Workbook exportData​(java.lang.String typeCode,
                                                java.util.List<SelectedAttribute> selectedAttributes)
        Exports data to excel workbook for given type
        Parameters:
        typeCode - type to export
        selectedAttributes - list of selected attributes which have metadata necessary for reimporting the data
        Returns:
        sheet