qgsserverquerystringparameter.h

Go to the documentation of this file.

/***************************************************************************
  qgsserverquerystringparameter.h - QgsServerQueryStringParameter
 
 ---------------------
 begin                : 10.7.2019
 copyright            : (C) 2019 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSSERVERQUERYSTRINGPARAMETER_H
#define QGSSERVERQUERYSTRINGPARAMETER_H
 
#include "qgis_server.h"
#include "qgis_sip.h"
#include "qgsserverapicontext.h"
 
#include <QObject>
#include <QString>
#include <QVariant>
 
#ifndef SIP_RUN
#include <nlohmann/json.hpp>
using namespace nlohmann;
#endif
 
 
class QgsServerApiBadRequestException;
 

class SERVER_EXPORT QgsServerQueryStringParameter
{
    Q_GADGET
 
#ifndef SIP_RUN
    typedef std::function<bool( const QgsServerApiContext &, QVariant & )> customValidator;
#endif
  public:
    enum class Type
    {
      String = QMetaType::Type::QString,   
      Integer = QMetaType::Type::LongLong, 
      Double = QMetaType::Type::Double,    
      Boolean = QMetaType::Type::Bool,     
      List = QMetaType::Type::QStringList, 
    };
    Q_ENUM( Type )
 
 
    
    QgsServerQueryStringParameter(
      const QString name, bool required = false, Type type = QgsServerQueryStringParameter::Type::String, const QString &description = QString(), const QVariant &defaultValue = QVariant()
    );
 
    virtual ~QgsServerQueryStringParameter();

    virtual QVariant value( const QgsServerApiContext &context ) const;
 
#ifndef SIP_RUN

    void setCustomValidator( const customValidator &customValidator );

    json data() const;
 
#endif

    QString description() const;

    static QString typeName( const Type type );

    QString name() const;

    void setDescription( const QString &description );

    bool hidden() const;

    void setHidden( bool hidden );
 
  private:
    QString mName;
    bool mRequired = false;
    Type mType = Type::String;
    customValidator mCustomValidator = nullptr;
    QString mDescription;
    QVariant mDefaultValue;
    bool mHidden = false;
 
    friend class TestQgsServerQueryStringParameter;
};
 
#endif // QGSSERVERQUERYSTRINGPARAMETER_H