SyncResults.h

/*
 * This file is part of buteo-syncfw package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 *
 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */
#ifndef SYNCRESULTS_H_2
#define SYNCRESULTS_H_2
 
#include <QDateTime>
#include <QList>
#include <QSharedPointer>
#include <QObject>
#include <QVariantList>
#include "TargetResults.h"
 
class QDomDocument;
class QDomElement;
 
namespace Buteo {
 
struct DatabaseResults
{
    int iLocalItemsAdded;       
    int iLocalItemsModified;    
    int iLocalItemsDeleted;     
 
    int iRemoteItemsAdded;      
    int iRemoteItemsModified;   
    int iRemoteItemsDeleted;    
 
    DatabaseResults()
        : iLocalItemsAdded(0)
        , iLocalItemsModified(0)
        , iLocalItemsDeleted(0)
        , iRemoteItemsAdded(0)
        , iRemoteItemsModified(0)
        , iRemoteItemsDeleted(0)
    {}
};
 
class SyncResultsPrivate;

class SyncResults
{
    Q_GADGET
    Q_PROPERTY(QDateTime syncTime READ syncTime CONSTANT)
    Q_PROPERTY(MajorCode majorCode READ majorCode CONSTANT)
    Q_PROPERTY(MinorCode minorCode READ minorCode CONSTANT)
    Q_PROPERTY(bool scheduled READ isScheduled CONSTANT)
    Q_PROPERTY(QString targetId READ getTargetId CONSTANT)
    Q_PROPERTY(QVariantList results READ variantTargetResults CONSTANT)
 
public:
    enum MajorCode {
        SYNC_RESULT_INVALID = -1,
        SYNC_RESULT_SUCCESS = 0,
        SYNC_RESULT_FAILED,
        SYNC_RESULT_CANCELLED
    };
    Q_ENUM(MajorCode)
 
    
    enum MinorCode {
        // No error
        NO_ERROR = 0,
 
        // Sync completed but some unblocking issues appeared 3xx
        ITEM_FAILURES = 301,
 
        // Client/Configuration errors 4xx
        INTERNAL_ERROR = 401,
        AUTHENTICATION_FAILURE,
        DATABASE_FAILURE,
        PLUGIN_ERROR,
        PLUGIN_TIMEOUT,
 
        // Server/Network errors 5xx
        ABORTED = 501,
        CONNECTION_ERROR,
        UNSUPPORTED_SYNC_TYPE,
        UNSUPPORTED_STORAGE_TYPE,
 
        // Context Error Code
        LOW_BATTERY_POWER = 601,
        POWER_SAVING_MODE,
        OFFLINE_MODE,
        BACKUP_IN_PROGRESS,
        LOW_MEMORY
    };
    Q_ENUM(MinorCode)
 
    
    SyncResults();

    SyncResults(const SyncResults &aSource);

    SyncResults(QDateTime aTime, MajorCode aMajorCode, MinorCode aMinorCode);

    explicit SyncResults(const QDomElement &aRoot);

    ~SyncResults();

    SyncResults &operator=(const SyncResults &aRhs);

    QDomElement toXml(QDomDocument &aDoc) const;

    QString toString() const;

    QList<TargetResults> targetResults() const;

    void addTargetResults(const TargetResults &aResults);

    QDateTime syncTime() const;

    MajorCode majorCode() const;

    void setMajorCode(MajorCode aMajorCode);

    MinorCode minorCode() const;

    void setMinorCode(MinorCode aMinorCode);
 

    void setTargetId(const QString &aTargetId);

    QString getTargetId() const;

    bool operator<(const SyncResults &aOther) const;

    void setScheduled(bool aScheduled);

    bool isScheduled() const;
 
private:
    QVariantList variantTargetResults() const;
    QSharedPointer<SyncResultsPrivate> d_ptr;
 
#ifdef SYNCFW_UNIT_TESTS
    friend class ClientThreadTest;
#endif
};
 
}
 
Q_DECLARE_METATYPE(Buteo::SyncResults)
 
#endif // SYNCRESULTS_H_2