ch.tatool.app.export
Interface DataExportService

All Known Implementing Classes:
DataExportServiceImpl

public interface DataExportService

Provides data export capability for a module. By default, an exporter class needs to be defined in order to be able to export data.

Author:
Michael Ruflin

Field Summary
static String PROPERTY_EXPORT_INCREMENTAL
          Whether exports should happen incrementally, or always the complete data be exported.
static String PROPERTY_EXPORTER_CLASS
          What exporter class to use for a given module.
static String PROPERTY_LAST_EXPORT_TIMESTAMP
          Last export date.
static String PROPERTY_LAST_EXPORTED_SESSION
          Last exported session.
 
Method Summary
 boolean containsPendingExportData(Module module, String exporterKey)
          Returns whether some or all of the data in the module is still due to be exported
 boolean exportConfigured(Module module, String exporterKey)
          Can the module be exported?
 String exportData(Component parent, Module module, String exporterKey)
          Exports the data.
 Date getLastExportDate(Module module, String exporterKey)
          Returns the date when the last data was exported.
 

Field Detail

PROPERTY_EXPORTER_CLASS

static final String PROPERTY_EXPORTER_CLASS
What exporter class to use for a given module.

See Also:
Constant Field Values

PROPERTY_EXPORT_INCREMENTAL

static final String PROPERTY_EXPORT_INCREMENTAL
Whether exports should happen incrementally, or always the complete data be exported. By default we always export the full data.

See Also:
Constant Field Values

PROPERTY_LAST_EXPORT_TIMESTAMP

static final String PROPERTY_LAST_EXPORT_TIMESTAMP
Last export date.

See Also:
Constant Field Values

PROPERTY_LAST_EXPORTED_SESSION

static final String PROPERTY_LAST_EXPORTED_SESSION
Last exported session.

See Also:
Constant Field Values
Method Detail

exportConfigured

boolean exportConfigured(Module module,
                         String exporterKey)
Can the module be exported? Currently an exporter class needs to be specified in order to allow exporting the data.


containsPendingExportData

boolean containsPendingExportData(Module module,
                                  String exporterKey)
Returns whether some or all of the data in the module is still due to be exported


getLastExportDate

Date getLastExportDate(Module module,
                       String exporterKey)
Returns the date when the last data was exported.


exportData

String exportData(Component parent,
                  Module module,
                  String exporterKey)
Exports the data.



Copyright © 2012. All Rights Reserved.