ImportHelper Class Reference

#include <importhelper.h>

Static Public Member Functions

static CSVImpPluginInterface * getCSVImpPlugin (QObject *parent=0)
 
static bool handleFilePostImport (const QString &pFileName, bool success, QString &errmsg, const QString &saveToErrorFile=QString())
 Obey the import file configuration and remove or rename the file that has just been imported.
 
static bool importCSV (const QString &pFileName, QString &errmsg)
 
static bool importXML (const QString &pFileName, QString &errmsg, QString &warnmsg)
 
static bool openDomDocument (const QString &pFileName, QDomDocument &pDoc, QString &errmsg)
 

Static Protected Attributes

static CSVImpPluginInterface * _csvimpplugin
 

Member Function Documentation

◆ getCSVImpPlugin()

CSVImpPluginInterface * ImportHelper::getCSVImpPlugin ( QObject * parent = 0)
static

◆ handleFilePostImport()

bool ImportHelper::handleFilePostImport ( const QString & pfilename,
bool success,
QString & errmsg,
const QString & saveToErrorFile = QString() )
static

Obey the import file configuration and remove or rename the file that has just been imported.

Parameters
[in]pfilenameThe name of the file that has just been imported.
[in]successAn indication of whether the import succeeded or not. This controls whether the import file pfilename will be handled using the configuration for successful imports or failed imports.
[out]errmsgAny error message generated during file handling.
[in]saveToErrorFileIf this is not an empty string, the string is saved to an error file using the configuration for handling error files.
Returns
true if the file was handled successfully, false if there was an error moving or deleting the file.

◆ importCSV()

bool ImportHelper::importCSV ( const QString & pFileName,
QString & errmsg )
static

◆ importXML()

bool ImportHelper::importXML ( const QString & pFileName,
QString & errmsg,
QString & warnmsg )
static

◆ openDomDocument()

bool ImportHelper::openDomDocument ( const QString & pFileName,
QDomDocument & pDoc,
QString & errmsg )
static

Member Data Documentation

◆ _csvimpplugin

CSVImpPluginInterface * ImportHelper::_csvimpplugin
staticprotected

The documentation for this class was generated from the following files:

Generated on Mon Feb 17 2025 xTuple ERP Programmer Reference, Version 6.1.0 doxygen 1.11.0