one.edee.babylon.export

Interface Exporter.SheetContract

All Known Implementing Classes:

LightGSheetServiceExporterContractAdaptor

Enclosing class:

Exporter

public static interface Exporter.SheetContract

Defines sheet operations required by Exporter.

Method Summary

Modifier and Type	Method and Description
void	createSheet(String spreadsheetId, String sheetTitle, List<List<String>> sheetRows, TranslationConfiguration configuration, Map<String,List<String>> translatedAutomatically, Set<String> translatedHistorically) Creates a new sheet in the specified spreadsheet with the given title, rows of data, and metadata, including locked cell editors, cells translated automatically, and cells translated historically.
void	deleteSheets(String spreadsheetId, Collection<Integer> sheetIds) Deletes specified sheets from given spreadsheet.
List<ASheet>	listSheets(String spreadsheetId) Lists all sheets of spreadsheet spreadsheetId.

Method Detail

listSheets

List<ASheet> listSheets(String spreadsheetId)
                 throws SheetsException

Lists all sheets of spreadsheet spreadsheetId. Does not fetch actual cells of the sheets.

Parameters:

spreadsheetId - id of spreadsheet

Returns:

sheets from spreadsheetId

Throws:

SheetsException - when unable to list sheets

deleteSheets

void deleteSheets(String spreadsheetId,
                  Collection<Integer> sheetIds)
           throws SheetsException

Deletes specified sheets from given spreadsheet.

Parameters:

spreadsheetId - spreadsheet to delete sheets from

sheetIds - ids of sheets to delete

Throws:

SheetsException - when unable to delete sheets

createSheet

void createSheet(String spreadsheetId,
                 String sheetTitle,
                 List<List<String>> sheetRows,
                 TranslationConfiguration configuration,
                 Map<String,List<String>> translatedAutomatically,
                 Set<String> translatedHistorically)
          throws SheetsException

Creates a new sheet in the specified spreadsheet with the given title, rows of data, and metadata, including locked cell editors, cells translated automatically, and cells translated historically. Throws an exception if the operation fails.

Parameters:

spreadsheetId - the ID of the spreadsheet where the sheet will be created

sheetTitle - the title of the new sheet

sheetRows - a list of rows where each row is represented as a list of strings

configuration - configuration of translation run

translatedAutomatically - a mapping of cell references to their translated values, where translation was performed automatically

translatedHistorically - a set of cell references that were translated manually in the past

Throws:

SheetsException - if the sheet cannot be created for any reason