/usr/include/buteosyncfw5/SyncResults.h is in libbuteosyncfw5-dev 0.7.21+16.04.20151216.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | /*
* 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 "TargetResults.h"
class QDomDocument;
class QDomElement;
namespace Buteo {
struct DatabaseResults {
int iLocalItemsAdded; /*!<The number of items added to the local database*/
int iLocalItemsModified; /*!<The number of items updated in the local database*/
int iLocalItemsDeleted; /*!<The number of items deleted from the local database*/
int iRemoteItemsAdded; /*!<The number of items added to the remote database*/
int iRemoteItemsModified; /*!<The number of items updated in the remote database*/
int iRemoteItemsDeleted; /*!<The number of items deleted from the remote database*/
DatabaseResults() : iLocalItemsAdded( 0 ), iLocalItemsModified( 0 ), iLocalItemsDeleted( 0 ),
iRemoteItemsAdded( 0 ), iRemoteItemsModified( 0 ), iRemoteItemsDeleted( 0 ) { }
};
class SyncResultsPrivate;
/*! \brief Contains information about a completed synchronization session.
*
* SyncResults consists of the sync time/date, result code and one
* TargetResults object for each sync target/storage (calendar, bookmarks
* etc.).
*/
class SyncResults
{
public:
/*! \brief enum value
*
* Used to set the major code in *.log.xml file for profile
*/
enum MajorCode {
SYNC_RESULT_INVALID = -1,
SYNC_RESULT_SUCCESS = 0,
SYNC_RESULT_FAILED,
SYNC_RESULT_CANCELLED
};
/*! \brief enum value
*
* Used to set the minor code in *.log.xml file for profile
*/
enum MinorCode {
//NO-Error
NO_ERROR = 0,
//These error codes are mapped to syncAgentConsts.h
// Successful 3xx
SYNC_FINISHED = 301,
// Client/Configuration errors 4xx
INTERNAL_ERROR = 401,
AUTHENTICATION_FAILURE,
DATABASE_FAILURE,
// Server/Network errors 5xx
SUSPENDED = 501,
ABORTED,
CONNECTION_ERROR,
INVALID_SYNCML_MESSAGE,
UNSUPPORTED_SYNC_TYPE,
UNSUPPORTED_STORAGE_TYPE,
//Upto here
//Context Error Code
LOW_BATTERY_POWER = 601,
POWER_SAVING_MODE,
OFFLINE_MODE,
BACKUP_IN_PROGRESS,
LOW_MEMORY
};
/*! \brief Constructs an empty sync results object.
*
* Sync time is set to current time, result code should be set later by
* calling setMajorCode , setMinorCode.
*/
SyncResults();
/*! \brief Copy constructor.
*
* \param aSource Copy source.
*/
SyncResults(const SyncResults &aSource);
/*! \brief Constructs sync results, sets sync time and result code.
*
* \param aTime Sync time for the results.
* \param aMajorCode Sync result code.
* \param aMinorCode Sync Failed Reason.
*/
SyncResults(QDateTime aTime, int aMajorCode, int aMinorCode);
/*! \brief Constructs sync results from XML.
*
* \param aRoot Root element of the XML representation.
*/
explicit SyncResults(const QDomElement &aRoot);
/*! \brief Destructor.
*/
~SyncResults();
/*! \brief Assignment operator.
*
* \param aRhs Source.
*/
SyncResults& operator=(const SyncResults &aRhs);
/*! \brief Exports the sync results to XML.
*
* \param aDoc Parent document for the created XML elements. The created
* elements are not inserted to the document by this function, but the
* document is still required for creating the elements.
* \return Root element of the created XML.
*/
QDomElement toXml(QDomDocument &aDoc) const;
/*! \brief Exports the sync results to QString.
*
* \return return the Results as xml formatted string
*/
QString toString() const;
/*! \brief Gets the results of all targets.
*
* \return List of target results.
*/
QList<TargetResults> targetResults() const;
/*! \brief Adds target results to this object.
*
* \param aResults The target results to add.
*/
void addTargetResults(const TargetResults &aResults);
/*! \brief Gets the sync time.
*
* \return Sync time.
*/
QDateTime syncTime() const;
/*! \brief Gets the result code.
*
* \return major code.
*/
int majorCode() const;
/*! \brief Sets the result code.
*
* \param aMajorCode The result code.
*/
void setMajorCode(int aMajorCode);
/*! \brief Gets the failed reason.
*
* \return failed Reason.
*/
int minorCode() const;
/*! \brief Sets the failed Reason.
*
* \param aMinorCode - minor code or the reason
*/
void setMinorCode(int aMinorCode);
/*! \brief Sets the remote target Id.
*
* \param aTargetId The remote device Id.
*/
void setTargetId(const QString& aTargetId) ;
/*! \brief Gets the remote target Id.
*/
QString getTargetId() const;
/*! \brief Compares two results objects by sync time.
*
* The object with earlier sync time is smaller.
* \param aOther Point of comparison.
*/
bool operator<(const SyncResults &aOther) const;
/*! \brief Sets if the results are from a scheduled sync.
*
* \param aScheduled True if this is a scheduled sync.
*/
void setScheduled(bool aScheduled);
/*! \brief Checks if the results are from a scheduled sync.
*
* \return True if scheduled.
*/
bool isScheduled() const;
private:
SyncResultsPrivate *d_ptr;
#ifdef SYNCFW_UNIT_TESTS
friend class ClientThreadTest;
#endif
};
}
#endif // SYNCRESULTS_H_2
|