1 /**
2  * Orthanc - A Lightweight, RESTful DICOM Store
3  * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4  * Department, University Hospital of Liege, Belgium
5  * Copyright (C) 2017-2021 Osimis S.A., Belgium
6  *
7  * This program is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public License
9  * as published by the Free Software Foundation, either version 3 of
10  * the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program. If not, see
19  * <http://www.gnu.org/licenses/>.
20  **/
21 
22 
23 #pragma once
24 
25 #include "JobStepResult.h"
26 
27 #include <boost/noncopyable.hpp>
28 #include <json/value.h>
29 
30 namespace Orthanc
31 {
32   class ORTHANC_PUBLIC IJob : public boost::noncopyable
33   {
34   public:
~IJob()35     virtual ~IJob()
36     {
37     }
38 
39     // Method called once the job enters the jobs engine
40     virtual void Start() = 0;
41 
42     virtual JobStepResult Step(const std::string& jobId) = 0;
43 
44     // Method called once the job is resubmitted after a failure
45     virtual void Reset() = 0;
46 
47     // For pausing/canceling/ending jobs: This method must release allocated resources
48     virtual void Stop(JobStopReason reason) = 0;
49 
50     virtual float GetProgress() = 0;
51 
52     virtual void GetJobType(std::string& target) = 0;
53 
54     virtual void GetPublicContent(Json::Value& value) = 0;
55 
56     virtual bool Serialize(Json::Value& value) = 0;
57 
58     // This function can only be called if the job has reached its
59     // "success" state
60     virtual bool GetOutput(std::string& output,
61                            MimeType& mime,
62                            const std::string& key) = 0;
63   };
64 }
65