job.h

/*
    Copyright (c) 2006 Tobias Koenig <tokoe@kde.org>
                  2006 Marc Mutz <mutz@kde.org>
                  2006 - 2007 Volker Krause <vkrause@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_JOB_H
#define AKONADI_JOB_H

#include "akonadi_export.h"

#include <kcompositejob.h>

class QString;

namespace Akonadi {

class JobPrivate;
class Session;
class SessionPrivate;

class AKONADI_EXPORT Job : public KCompositeJob
{
    Q_OBJECT

    friend class Session;
    friend class SessionPrivate;

public:
    typedef QList<Job *> List;

    enum Error {
        ConnectionFailed = UserDefinedError, 
        ProtocolVersionMismatch,             
        UserCanceled,                        
        Unknown,                             
        UserError = UserDefinedError + 42    
    };

    explicit Job(QObject *parent = 0);

    virtual ~Job();

    void start();

    virtual QString errorString() const;

Q_SIGNALS:
    void aboutToStart(Akonadi::Job *job);

    void writeFinished(Akonadi::Job *job);

protected:
    virtual void doStart() = 0;

    virtual void doHandleResponse(const QByteArray &tag, const QByteArray &data);

    virtual bool addSubjob(KJob *job);

    virtual bool removeSubjob(KJob *job);

    virtual bool doKill();

    void emitWriteFinished();

protected Q_SLOTS:
    virtual void slotResult(KJob *job);

protected:
    //@cond PRIVATE
    Job(JobPrivate *dd, QObject *parent);
    JobPrivate *const d_ptr;
    //@endcond

private:
    Q_DECLARE_PRIVATE(Job)

    //@cond PRIVATE
    Q_PRIVATE_SLOT(d_func(), void slotSubJobAboutToStart(Akonadi::Job *))
    Q_PRIVATE_SLOT(d_func(), void startNext())
    Q_PRIVATE_SLOT(d_func(), void signalCreationToJobTracker())
    Q_PRIVATE_SLOT(d_func(), void signalStartedToJobTracker())
    Q_PRIVATE_SLOT(d_func(), void delayedEmitResult())
    //@endcond
};

}

#endif