/****************************************************************************
**
** https://www.qxorm.com/
** Copyright (C) 2013 XDL Team (ic-east.com)
**
** This file is part of the QxOrm library
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any
** damages arising from the use of this software
**
** Commercial Usage
** Licensees holding valid commercial QxOrm licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and XDL Team
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file 'license.gpl3.txt' included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met : http://www.gnu.org/copyleft/gpl.html
**
** If you are unsure which license is appropriate for your use, or
** if you have questions regarding the use of this file, please contact :
** ic-east.com
**
****************************************************************************/

#ifndef _QX_SQL_LIMIT_H_
#define _QX_SQL_LIMIT_H_

#ifdef _MSC_VER
#pragma once
#endif

/*!
 * \file QxSqlLimit.h
 * \author XDL Team
 * \ingroup QxDao
 * \brief SQL element to limit rows count fetched from database
 */

#include <QxDao/QxSqlElement/IxSqlElement.h>

namespace qx
{
   namespace dao
   {
      namespace detail
      {

         /*!
          * \ingroup QxDao
          * \brief qx::dao::detail::QxSqlLimit : SQL element to limit rows count fetched from database
          */
         class QX_DLL_EXPORT QxSqlLimit : public IxSqlElement
         {

         public:
            QxSqlLimit();
            QxSqlLimit(int index);
            virtual ~QxSqlLimit();

            virtual QString toString() const;
            virtual void resolve(QSqlQuery &query, qx::QxCollection<QString, QVariantList> *pLstExecBatch = NULL) const;
            virtual void postProcess(QString &sql) const;

            int getStartRow() const;
            int getRowsCount() const;
            int getMaxRow() const;
            bool getWithTies() const;

            QString getStartRow_ParamKey() const;
            QString getRowsCount_ParamKey() const;
            QString getMaxRow_ParamKey() const;

            virtual IxSqlElement::type_class getTypeClass() const;

         protected:
            virtual QString getExtraSettings() const;
            virtual void setExtraSettings(const QString &s);
         };

         typedef std::shared_ptr<QxSqlLimit> QxSqlLimit_ptr;

      } // namespace detail
   } // namespace dao
} // namespace qx

#endif // _QX_SQL_LIMIT_H_
