Package com.orchestranetworks.addon.dex.result

Classes and interfaces to define a result when executing data import, export and transfer.

See: Description

Interface Summary

Interface	Description
DataExchangeResult	Stores data results when executing data import, export and transfer.
DataExchangeResult.CSVExport	Stores data results when executing the CSV export.
DataExchangeResult.CSVImport	Stores data results when executing CSV import.
DataExchangeResult.SpreadsheetExport	Stores data results when executing Excel export.
DataExchangeResult.SpreadsheetImport	Stores data results when executing Excel import.
DataExchangeResult.SQLExport	Stores data results when executing SQL export.
DataExchangeResult.SQLImport	Stores data results when executing SQL import.
DataExchangeResult.Transfer	Stores data results when executing a data transfer.
DataExchangeResult.XMLExport	Stores data results when executing XML export.
DataExchangeResult.XMLImport	Stores data results when executing XML import.
ExportResult	Stores the results when exporting data from one table.
ImportResult	Stores data results when importing data into a table.
Result	Defines data results when executing data import, export, transfer from the source table to the target table.
TransferResult	Stores data results when transferring data into a table.

Class Summary

Class	Description
ResultList	Defines a list of Result.

Package com.orchestranetworks.addon.dex.result Description

Classes and interfaces to define a result when executing data import, export and transfer.

XML export result example

        DataExchangeResult.XMLExport xmlExportResult = (XMLExport) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);

        // Get the exported file.
        xmlExportResult.getExportedFile();
        // Get the error messages of the export.
        xmlExportResult.getErrorMessages();
        // Get the warning messages of the export.
        xmlExportResult.getWarningMessages();
        // Get the export result when exporting data from each EBX® table.
        Iterator<ExportResult> exportResults = xmlExportResult.getResults();
        while (exportResults.hasNext())
        {
                ExportResult exportResult = exportResults.next();
                exportResult.getNumberOfExportedRecords();
                exportResult.getNumberOfInvalidRecords();
                exportResult.getNumberOfProcessedRecords();
        }

XML import result example

        DataExchangeResult.XMLImport xmlImportResult = (XMLImport) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);
        
        // Get the error messages of the import.
        xmlImportResult.getErrorMessages();
        // Get the warning messages of the import.
        xmlImportResult.getWarningMessages();
        // Get the import result when importing data into each EBX® table.
        Iterator<ImportResult> importResults = xmlImportResult.getResults();
        while (importResults.hasNext())
        {
                ImportResult importResult = importResults.next();
                importResult.getNumberOfCreatedRecords();
                importResult.getNumberOfUpdatedRecords();
                importResult.getNumberOfDeletedRecords();
                importResult.getNumberOfInvalidRecords();
                importResult.getNumberOfProcessedRecords();
        }

Transfer result example

        DataExchangeResult.Transfer transferResult = (Transfer) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);
        
        // Get the error messages of the transfer.
        transferResult.getErrorMessages();
        // Get the warning messages of the transfer.
        transferResult.getWarningMessages();
        // Get the transfer result of each table.
        Iterator<TransferResult> transferResults = transferResult.getResults();
        while (transferResults.hasNext())
        {
                TransferResult result = transferResults.next();
                result.getNumberOfCreatedRecords();
                result.getNumberOfUpdatedRecords();
                result.getNumberOfDeletedRecords();
                result.getNumberOfInvalidRecords();
                result.getNumberOfProcessedRecords();
        }

Example of a spreadsheet export result

        DataExchangeResult.SpreadsheetExport spreadsheetExportResult = (SpreadsheetExport) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);

        // Get the exported file.
        spreadsheetExportResult.getExportedFile();
        // Get the error messages of the export.
        spreadsheetExportResult.getErrorMessages();
        // Get the warning messages of the export.
        spreadsheetExportResult.getWarningMessages();
        // Get the export result when exporting data from each EBX® table.
        Iterator<ExportResult> eportResults = spreadsheetExportResult.getResults();
        while (eportResults.hasNext())
        {
                ExportResult exportResult = eportResults.next();
                exportResult.getNumberOfExportedRecords();
                exportResult.getNumberOfInvalidRecords();
                exportResult.getNumberOfProcessedRecords();
        }

Example of a spreadsheet import result

        DataExchangeResult.SpreadsheetImport spreadsheetImportResult = (SpreadsheetImport) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);

        // Get the error file which contains all the invalid records found during import.
        spreadsheetImportResult.getErrorFile();
        // Get the error messages of the import.
        spreadsheetImportResult.getErrorMessages();
        // Get the warning messages of the import.
        spreadsheetImportResult.getWarningMessages();
        // Get the import result when importing data into each EBX® table.
        Iterator<ImportResult> importResults = spreadsheetImportResult.getResults();
        while (importResults.hasNext())
        {
                ImportResult importResult = importResults.next();
                importResult.getNumberOfCreatedRecords();
                importResult.getNumberOfUpdatedRecords();
                importResult.getNumberOfDeletedRecords();
                importResult.getNumberOfInvalidRecords();
                importResult.getNumberOfProcessedRecords();
        }

Example of a CSV export result

        DataExchangeResult.CSVExport csvExportResult = (CSVExport) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);

        // Get the exported file.
        csvExportResult.getExportedFile();
        // Get the error messages of the export.
        csvExportResult.getErrorMessages();
        // Get the warning messages of the export.
        csvExportResult.getWarningMessages();
        // Get the export result when exporting data from each EBX® table.
        Iterator<ExportResult> exportResults = csvExportResult.getResults();
        while (exportResults.hasNext())
        {
                ExportResult exportResult = exportResults.next();
                exportResult.getNumberOfExportedRecords();
                exportResult.getNumberOfInvalidRecords();
                exportResult.getNumberOfProcessedRecords();
        }       

Example of a CSV import result

        DataExchangeResult.CSVImport csvImportResult = (CSVImport) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);

        // Get the error file which contains all the invalid records during the import.
        csvImportResult.getErrorFile();
        // Get the error messages of the import.
        csvImportResult.getErrorMessages();
        // Get the warning messages of the import.
        csvImportResult.getWarningMessages();
        // Get the import result when importing data into each EBX® table.
        Iterator<ImportResult> importResults = csvImportResult.getResults();
        while (importResults.hasNext())
        {
                ImportResult importResult = importResults.next();
                importResult.getNumberOfCreatedRecords();
                importResult.getNumberOfUpdatedRecords();
                importResult.getNumberOfDeletedRecords();
                importResult.getNumberOfInvalidRecords();
                importResult.getNumberOfProcessedRecords();
        }

Example of a SQL export result

        DataExchangeResult.SQLExport sqlExportResult = (SQLExport) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);

        // Get the error messages of the export.
        sqlExportResult.getErrorMessages();
        // Get the warning messages of the export.
        sqlExportResult.getWarningMessages();
        // Get the result when exporting data from each EBX® table.
        Iterator<ExportResult> exportResults = sqlExportResult.getResults();
        while (exportResults.hasNext())
        {
                ExportResult exportResult = eportResults.next();
                exportResult.getNumberOfExportedRecords();
                exportResult.getNumberOfInvalidRecords();
                exportResult.getNumberOfProcessedRecords();
        }

Example of a SQL import result

        DataExchangeResult.SQLImport sqlImportResult = (SQLImport) DataExchangeServiceFactory.getDataExchangeService().execute(dataExchangeSpec);

        // Get the error messages of the import.
        sqlImportResult.getErrorMessages();
        // Get the warning messages of the import.
        sqlImportResult.getWarningMessages();
        // Get the result when importing data into each EBX® table.
        Iterator<ImportResult> importResults = sqlImportResult.getResults();
        while (importResults.hasNext())
        {
                ImportResult importResult = importResults.next();
                importResult.getNumberOfCreatedRecords();
                importResult.getNumberOfUpdatedRecords();
                importResult.getNumberOfDeletedRecords();
                importResult.getNumberOfInvalidRecords();
                importResult.getNumberOfProcessedRecords();
        }