/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 * Copyright (C) 2017-2018 Osimis S.A., Belgium
 *
 * 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 3 of the
 * License, or (at your option) any later version.
 *
 * In addition, as a special exception, the copyright holders of this
 * program give permission to link the code of its release with the
 * OpenSSL project's "OpenSSL" library (or with modified versions of it
 * that use the same license as the "OpenSSL" library), and distribute
 * the linked executables. You must obey the GNU General Public License
 * in all respects for all of the code used other than "OpenSSL". If you
 * modify file(s) with this exception, you may extend this exception to
 * your version of the file(s), but you are not obligated to do so. If
 * you do not wish to do so, delete this exception statement from your
 * version. If you delete this exception statement from all source files
 * in the program, then also delete it here.
 * 
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 **/


#pragma once

#include "ServerCommandInstance.h"
#include "../../Core/MultiThreading/SharedMessageQueue.h"

namespace Orthanc
{
  class ServerJob
  {
    friend class ServerScheduler;

  private:
    std::list<ServerCommandInstance*> filters_;
    std::list<IDynamicObject*> payloads_;
    std::string jobId_;
    bool submitted_;
    std::string description_;

    void CheckOrdering();

    size_t Submit(SharedMessageQueue& target,
                  ServerCommandInstance::IListener& listener);

  public:
    ServerJob();

    ~ServerJob();

    const std::string& GetId() const
    {
      return jobId_;
    }

    void SetDescription(const std::string& description)
    {
      description_ = description;
    }

    const std::string& GetDescription() const
    {
      return description_;
    }

    ServerCommandInstance& AddCommand(IServerCommand* filter);

    // Take the ownership of a payload to a job. This payload will be
    // automatically freed when the job succeeds or fails.
    IDynamicObject& AddPayload(IDynamicObject* payload);
  };
}