SyncProfile.h

/*
 * This file is part of buteo-syncfw package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 * Copyright (C) 2014-2019 Jolla Ltd.
 * Copyright (C) 2020 Open Mobile Platform LLC.
 *
 * 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 SYNCPROFILE_H
#define SYNCPROFILE_H
 
#include "Profile.h"
#include "SyncLog.h"
#include "SyncSchedule.h"
#include "SyncCommonDefs.h"
 
namespace Buteo {
 
class SyncProfilePrivate;
 
class SyncProfile : public Profile
{
public:
    enum SyncType
    {
        SYNC_MANUAL,
 
        SYNC_SCHEDULED
    };
 
    enum DestinationType
    {
        DESTINATION_TYPE_DEVICE,
 
        DESTINATION_TYPE_ONLINE,
 
        DESTINATION_TYPE_UNDEFINED
    };
 
    enum SyncDirection
    {
        SYNC_DIRECTION_TWO_WAY,
 
        SYNC_DIRECTION_FROM_REMOTE,
 
        SYNC_DIRECTION_TO_REMOTE,
 
        SYNC_DIRECTION_UNDEFINED
    };
 
    enum ConflictResolutionPolicy
    {
        CR_POLICY_PREFER_LOCAL_CHANGES,
 
        CR_POLICY_PREFER_REMOTE_CHANGES,
 
        CR_POLICY_UNDEFINED
    };
 
    enum CurrentSyncStatus
    {
        SYNC_NEVER_HAPPENED,
 
        SYNC_SUCCESS,
 
        SYNC_FAILED,
 
        SYNC_CANCLLED
    };
 
    explicit SyncProfile(const QString &aName);
 
    explicit SyncProfile(const QDomElement &aRoot);
 
    SyncProfile(const SyncProfile &aSource);
 
    ~SyncProfile();
 
    virtual SyncProfile *clone() const;
 
 
    virtual void setName(const QString &aName);
 
    virtual void setName(const QStringList &aKeys);
 
 
    virtual QDomElement toXml(QDomDocument &aDoc, bool aLocalOnly = true) const;
 
    virtual bool syncExternallyEnabled() const;
 
    virtual bool rushEnabled() const;
 
    virtual bool syncExternallyDuringRush() const;
 
    virtual bool inExternalSyncRushPeriod(QDateTime aDateTime = QDateTime::currentDateTime()) const;
 
    QDateTime lastSyncTime() const;
 
    QDateTime lastSuccessfulSyncTime() const;
 
    virtual QDateTime nextSyncTime(QDateTime aDateTime = QDateTime::currentDateTime()) const;
 
    QDateTime nextRushSwitchTime(const QDateTime& aFromTime) const;
 
    const SyncResults *lastResults() const;
 
    SyncLog *log() const;
 
    void setLog(SyncLog *aLog);
 
    void addResults(const SyncResults &aResults);
 
    SyncType syncType() const;
 
    void setSyncType(SyncType aType);
 
    QStringList storageBackendNames() const;
 
    SyncSchedule syncSchedule() const;
 
    void setSyncSchedule(const SyncSchedule &aSchedule);
 
    QList<Sync::InternetConnectionType> internetConnectionTypes() const;
 
    void setInternetConnectionTypes(const QList<Sync::InternetConnectionType> &aTypes);
 
    //const Profile *serviceProfile() const;
 
    //Profile *serviceProfile();
 
    const Profile *clientProfile() const;
 
    Profile *clientProfile();
 
    const Profile *serverProfile() const;
 
    Profile *serverProfile();
 
    QList<const Profile*> storageProfiles() const;
 
    QList<Profile*> storageProfilesNonConst();
 
    DestinationType destinationType() const;
 
    SyncDirection syncDirection() const;
 
    void setSyncDirection(SyncDirection aDirection);
 
    ConflictResolutionPolicy conflictResolutionPolicy() const;
 
    void setConflictResolutionPolicy(ConflictResolutionPolicy aPolicy);
 
    QString serviceName() const;
 
    quint32 syncOnChangeAfter() const;
 
    bool isSOCProfile() const;
 
    bool hasRetries() const;
    QList<quint32> retryIntervals() const;
 
    CurrentSyncStatus currentSyncStatus() const;
 
private:
 
    SyncProfile& operator=(const SyncProfile &aRhs);
 
    SyncProfilePrivate *d_ptr;
};
 
}
 
#endif // SYNCPROFILE_H