/*
 * @project      The CERN Tape Archive (CTA)
 * @copyright    Copyright © 2021-2022 CERN
 * @license      This program is free software, distributed under the terms of the GNU General Public
 *               Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING". You can
 *               redistribute it and/or modify it under the terms of the GPL Version 3, or (at your
 *               option) any later version.
 *
 *               This program is distributed in the hope that it will be useful, but WITHOUT ANY
 *               WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 *               PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 *               In applying this licence, CERN does not waive the privileges and immunities
 *               granted to it by virtue of its status as an Intergovernmental Organization or
 *               submit itself to any jurisdiction.
 */

#pragma once

#include "rdbms/DBException.hpp"

#include <string>


namespace cta::rdbms {

/**
 * A database constraint error.
 */
class ConstraintError : public DBException {
public:
  /**
   * Constructor
   *
   * @param context optional context string added to the message
   * at initialisation time.
   * @param embedBacktrace whether to embed a backtrace of where the
   * exception was throw in the message
   */
  ConstraintError(const std::string &context, const std::string &dbErrorMessage, const std::string &violatedConstraintName, const bool embedBacktrace = true);

  /**
   * Empty Destructor (needed for std::exception inheritance)
   */
  ~ConstraintError() override = default;

  /**
   * Returns the violated constraint name, as returned by the DB
   */
  std::string getViolatedConstraintName() const;

private:
  std::string m_violatedConstraintName;
}; // class ConstraintError

} // namespace cta::rdbms