QxOrm  1.4.8
C++ Object Relational Mapping library
QxRestApi.h
Go to the documentation of this file.
00001 /****************************************************************************
00002 **
00003 ** https://www.qxorm.com/
00004 ** Copyright (C) 2013 Lionel Marty (contact@qxorm.com)
00005 **
00006 ** This file is part of the QxOrm library
00007 **
00008 ** This software is provided 'as-is', without any express or implied
00009 ** warranty. In no event will the authors be held liable for any
00010 ** damages arising from the use of this software
00011 **
00012 ** Commercial Usage
00013 ** Licensees holding valid commercial QxOrm licenses may use this file in
00014 ** accordance with the commercial license agreement provided with the
00015 ** Software or, alternatively, in accordance with the terms contained in
00016 ** a written agreement between you and Lionel Marty
00017 **
00018 ** GNU General Public License Usage
00019 ** Alternatively, this file may be used under the terms of the GNU
00020 ** General Public License version 3.0 as published by the Free Software
00021 ** Foundation and appearing in the file 'license.gpl3.txt' included in the
00022 ** packaging of this file. Please review the following information to
00023 ** ensure the GNU General Public License version 3.0 requirements will be
00024 ** met : http://www.gnu.org/copyleft/gpl.html
00025 **
00026 ** If you are unsure which license is appropriate for your use, or
00027 ** if you have questions regarding the use of this file, please contact :
00028 ** contact@qxorm.com
00029 **
00030 ****************************************************************************/
00031 
00032 #ifndef _QX_REST_API_H_
00033 #define _QX_REST_API_H_
00034 
00035 #ifdef _MSC_VER
00036 #pragma once
00037 #endif
00038 
00046 #ifdef _QX_NO_PRECOMPILED_HEADER
00047 #ifndef Q_MOC_RUN
00048 #include <QxPrecompiled.h> // Need to include precompiled header for the generated moc file
00049 #endif // Q_MOC_RUN
00050 #endif // _QX_NO_PRECOMPILED_HEADER
00051 
00052 #include <QtSql/qsqlerror.h>
00053 
00054 #ifndef _QX_NO_JSON
00055 #include <QtCore/qjsonvalue.h>
00056 #include <QtCore/qjsonobject.h>
00057 #include <QtCore/qjsonarray.h>
00058 #include <QtCore/qjsondocument.h>
00059 #endif // _QX_NO_JSON
00060 
00061 namespace qx {
00062 
00067 class QX_DLL_EXPORT QxRestApi : public QObject
00068 {
00069 
00070    Q_OBJECT
00071 
00072 private:
00073 
00074    struct QxRestApiImpl;
00075    std::unique_ptr<QxRestApiImpl> m_pImpl; 
00076 
00077 public:
00078 
00079    QxRestApi(QObject * parent = NULL);
00080    virtual ~QxRestApi();
00081 
00082    Q_INVOKABLE QString processRequest(const QString & request);
00083    Q_INVOKABLE void clearAll();
00084 
00085    Q_INVOKABLE QString getErrorDesc() const;
00086    Q_INVOKABLE int getErrorCode() const;
00087    QSqlError getError() const;
00088 
00089 #if (QT_VERSION >= 0x050300)
00090    Q_INVOKABLE QString getNativeErrorCode() const;
00091 #endif // (QT_VERSION >= 0x050300)
00092 
00093    Q_INVOKABLE void setEntity(const QString & entity);
00094    Q_INVOKABLE void setAction(const QString & action);
00095    Q_INVOKABLE void setFunction(const QString & fct);
00096    Q_INVOKABLE void setColumns(const QStringList & columns);
00097    Q_INVOKABLE void setRelations(const QStringList & relations);
00098    Q_INVOKABLE void setOutputFormat(const QStringList & outputFormat);
00099    Q_INVOKABLE void setDatabase(const QString & database);
00100    Q_INVOKABLE void setQuery(const QString & query);
00101    Q_INVOKABLE void setData(const QString & data);
00102 
00103 #ifndef _QX_NO_JSON
00104    QJsonValue processRequest(const QJsonValue & request);
00105    void setData(const QJsonValue & data);
00106 #endif // _QX_NO_JSON
00107 
00108 };
00109 
00110 } // namespace qx
00111 
00112 #endif // _QX_REST_API_H_