Class FileExportConfigurationSpec
java.lang.Object
com.orchestranetworks.addon.dex.configuration.FileExportConfigurationSpec
- All Implemented Interfaces:
ConfigurationSpec<EBXTable>
,ExportConfigurationSpec<EBXTable>
- Direct Known Subclasses:
CSVExportConfigurationSpec
,SpreadsheetExportConfigurationSpec
,XMLExportConfigurationSpec
public abstract class FileExportConfigurationSpec
extends Object
implements ExportConfigurationSpec<EBXTable>
Defines the configuration used for exporting data to a file.
- Since:
- 2.3.0
-
Constructor Summary
ConstructorsConstructorDescriptionFileExportConfigurationSpec
(com.onwbp.adaptation.AdaptationTable currentTable, com.orchestranetworks.service.Session session) Exports a table outside of aUIService
.FileExportConfigurationSpec
(com.orchestranetworks.service.ServiceContext serviceContext) Exports within aUIService
. -
Method Summary
Modifier and TypeMethodDescriptionfinal com.onwbp.adaptation.Adaptation
Returns the current dataset.final com.onwbp.adaptation.AdaptationTable
Returns the current table.final Locale
Returns the specific locale.final com.orchestranetworks.service.Session
Returns the current session.final boolean
Returnstrue
if the exported XML file contains computed values.boolean
Returnstrue
if the export includes the related data from the referenced tables.boolean
Returnstrue
if the export includes the related data from tables that reference the selected record.final boolean
Returnstrue
if the first row of every column in the file contains the column label in the Excel, CSV file or the exported XML file contains EBX Data Exchange Add-on header.final boolean
Deprecated.Since 3.0.0, the 'Disable write access lock' option was removed from the add-on.final void
setComputedValueIncluded
(boolean computedValueIncluded) Sets whether to include computed values in the exported XML file.void
setDataFromReferencedTablesExported
(boolean dataFromReferencedTablesExported) Sets whether the export includes the related data from the referenced tables.void
setDataReferencingSelectedRecordExported
(boolean dataReferencingSelectedRecordExported) Sets whether the export includes related data from tables that reference the selected record.final void
setHeaderExported
(boolean headerExported) Sets whether the first row of every column in the file contains the column label in the Excel, CSV file or the exported XML file contains EBX Data Exchange Add-on header.final void
Sets the specific locale.final void
setWriteAccessLockDisabled
(boolean writeAccessLockDisabled) Deprecated.Since 3.0.0, the 'Disable write access lock' option was removed from the add-on.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.orchestranetworks.addon.dex.configuration.ConfigurationSpec
getServiceType, getSourceTableFilters, getSourceTables
-
Constructor Details
-
FileExportConfigurationSpec
public FileExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext) throws DataExchangeException Exports within aUIService
.- Throws:
DataExchangeException
-
FileExportConfigurationSpec
public FileExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, com.orchestranetworks.service.Session session) throws DataExchangeException Exports a table outside of aUIService
.- Throws:
DataExchangeException
-
-
Method Details
-
isWriteAccessLockDisabled
public final boolean isWriteAccessLockDisabled()Deprecated.Since 3.0.0, the 'Disable write access lock' option was removed from the add-on.Always throws exception.- Specified by:
isWriteAccessLockDisabled
in interfaceExportConfigurationSpec<EBXTable>
-
setWriteAccessLockDisabled
public final void setWriteAccessLockDisabled(boolean writeAccessLockDisabled) Deprecated.Since 3.0.0, the 'Disable write access lock' option was removed from the add-on.Always throws exception. -
isHeaderExported
public final boolean isHeaderExported()Returnstrue
if the first row of every column in the file contains the column label in the Excel, CSV file or the exported XML file contains EBX Data Exchange Add-on header. -
setHeaderExported
public final void setHeaderExported(boolean headerExported) Sets whether the first row of every column in the file contains the column label in the Excel, CSV file or the exported XML file contains EBX Data Exchange Add-on header. -
isComputedValueIncluded
public final boolean isComputedValueIncluded()Returnstrue
if the exported XML file contains computed values.- Specified by:
isComputedValueIncluded
in interfaceExportConfigurationSpec<EBXTable>
-
setComputedValueIncluded
public final void setComputedValueIncluded(boolean computedValueIncluded) Sets whether to include computed values in the exported XML file. -
getCurrentDataset
public final com.onwbp.adaptation.Adaptation getCurrentDataset()Returns the current dataset.- Specified by:
getCurrentDataset
in interfaceConfigurationSpec<EBXTable>
-
getCurrentTable
public final com.onwbp.adaptation.AdaptationTable getCurrentTable()Returns the current table.- Specified by:
getCurrentTable
in interfaceConfigurationSpec<EBXTable>
-
getSession
public final com.orchestranetworks.service.Session getSession()Returns the current session.- Specified by:
getSession
in interfaceConfigurationSpec<EBXTable>
-
getLocale
Returns the specific locale. Returns the session's current locale by the default. -
setLocale
Sets the specific locale. -
isDataFromReferencedTablesExported
public boolean isDataFromReferencedTablesExported()Returnstrue
if the export includes the related data from the referenced tables. The export includes data referenced by a foreign key from the exported record(s). This option is only available when exporting a single table, it does not support exporting multiple tables.- Since:
- 2.5.0
-
setDataFromReferencedTablesExported
public void setDataFromReferencedTablesExported(boolean dataFromReferencedTablesExported) Sets whether the export includes the related data from the referenced tables. The export includes data referenced by a foreign key from the exported record(s). This option is only available when exporting a single table, it does not support exporting multiple tables.- Since:
- 2.5.0
-
isDataReferencingSelectedRecordExported
public boolean isDataReferencingSelectedRecordExported()Returnstrue
if the export includes the related data from tables that reference the selected record. The export includes data from tables that hold a relationship to the exported record. This option is only available when exporting a single record.- Since:
- 2.5.0
-
setDataReferencingSelectedRecordExported
public void setDataReferencingSelectedRecordExported(boolean dataReferencingSelectedRecordExported) Sets whether the export includes related data from tables that reference the selected record. The export includes data from tables that hold a relationship to the exported record. This option is only available when exporting a single record.- Since:
- 2.5.0
-