com.hybris.backoffice.excel.importing

Interface ExcelImportService

All Known Implementing Classes:

DefaultExcelImportService

public interface ExcelImportService

Service responsible for generating Impex based on excel file represented by Workbook object. In order to generating impex script, we can pass the result of {#importData} to ImpexConverter.convert(Impex).

Method Summary

Modifier and Type	Method and Description
Impex	convertToImpex(Workbook workbook) Transforms excel workbook into Impex object.
java.util.List<ExcelValidationResult>	validate(Workbook workbook) Deprecated. since 6.7 please use validate(Workbook, Set)
default java.util.List<ExcelValidationResult>	validate(Workbook workbook, java.util.Set<java.lang.String> mediaContentEntries) Validates a workbook.

Method Detail

convertToImpex

Impex convertToImpex(Workbook workbook)

Transforms excel workbook into Impex object. It takes into account all sheets included in excel file.

Parameters:

workbook - Workbook object which represents excel file

Returns:

generated Impex object which represents data from the workbook

validate

@Deprecated
java.util.List<ExcelValidationResult> validate(Workbook workbook)

Deprecated. since 6.7 please use validate(Workbook, Set)

Validates a workbook.

Parameters:

workbook - workbook to validate.

Returns:

list of validation results.

validate

default java.util.List<ExcelValidationResult> validate(Workbook workbook,
                                                       java.util.Set<java.lang.String> mediaContentEntries)

Validates a workbook.

Parameters:

workbook - workbook to validate.

mediaContentEntries - set of entries names inside media content attached to the excel file. Null if media is not attached.

Returns:

list of validation results.