Changes : Make Display Lables work
[qtcontacts-tracker:qtcontacts-tracker.git] / src / engine / engine.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the Qt Mobility Components.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** No Commercial Usage
11 ** This file contains pre-release code and may not be distributed.
12 ** You may use this file in accordance with the terms and conditions
13 ** contained in the Technology Preview License Agreement accompanying
14 ** this package.
15 **
16 ** GNU Lesser General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU Lesser
18 ** General Public License version 2.1 as published by the Free Software
19 ** Foundation and appearing in the file LICENSE.LGPL included in the
20 ** packaging of this file.  Please review the following information to
21 ** ensure the GNU Lesser General Public License version 2.1 requirements
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23 **
24 ** In addition, as a special exception, Nokia gives you certain additional
25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27 **
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
30 **
31 **
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QTRACKERCONTACTENGINE_H
43 #define QTRACKERCONTACTENGINE_H
44
45 //
46 //  W A R N I N G
47 //  -------------
48 //
49 // This file is not part of the Qt API.  It exists purely as an
50 // implementation detail.  This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55
56 #include <dao/contactdetailschema.h>
57 #include <QtTracker/Tracker>
58
59 QTM_USE_NAMESPACE;
60
61 using namespace SopranoLive;
62
63 class QContactTrackerEngineData;
64
65 class QContactTrackerEngine : public QContactManagerEngine
66 {
67 Q_OBJECT
68
69 public:
70     QContactTrackerEngine(const QString& managerName, int managerVersion, const QMap<QString, QString>& parameters);
71     QContactTrackerEngine(const QMap<QString, QString>& parameters);        // XXX FIXME: I don't think this is used in your factory code either?
72     QContactTrackerEngine(const QContactTrackerEngine& other);              // XXX FIXME: not used in your factory code...?
73     ~QContactTrackerEngine();
74     QContactTrackerEngine& operator=(const QContactTrackerEngine& other);   // XXX FIXME: not used in your factory code...?
75     QContactManagerEngine* clone();                                         // XXX FIXME: no longer part of the engine API
76     void deref();                                                           // XXX FIXME: no longer part of the engine API
77
78     // sync methods, wrapping async methods & waitForFinished
79     QList<QContactLocalId> contactIds(const QList<QContactSortOrder>& sortOrders, QContactManager::Error* error) const; // XXX FIXME: no longer part of engine API.
80     QList<QContactLocalId> contactIds(const QContactFilter& filter, const QList<QContactSortOrder>& sortOrders, QContactManager::Error* error) const;
81     QList<QContact> contacts(const QContactFilter& filter, const QList<QContactSortOrder>& sortOrders, const QContactFetchHint& fetchHint, QContactManager::Error* error) const;
82     QContact contact(const QContactLocalId& contactId, const QContactFetchHint& fetchHint, QContactManager::Error* error) const;
83
84     /* Save contacts - single and in batch */
85     bool saveContact( QContact* contact, QContactManager::Error* error);
86     bool saveContacts(QList<QContact>* contacts, QMap<int, QContactManager::Error>* errorMap, QContactManager::Error* error);
87
88     bool removeContact(const QContactLocalId& contactId, QContactManager::Error* error);
89     bool removeContacts(const QList<QContactLocalId>& contactIds, QMap<int, QContactManager::Error>* errorMap, QContactManager::Error* error) ;
90
91     /* Definitions - Accessors and Mutators */
92     QMap<QString, QContactDetailDefinition> detailDefinitions(const QString& contactType, QContactManager::Error* error) const;
93     QContactDetailDefinition detailDefinition(const QString&, const QString&, QContactManager::Error* error) const;
94     const QTrackerContactDetailSchema& detailSchema() const;
95
96     bool setSelfContactId(const QContactLocalId&, QContactManager::Error* error);
97     QContactLocalId selfContactId(QContactManager::Error* error) const;
98
99     /* Asynchronous Request Support */
100     void requestDestroyed(QContactAbstractRequest* req);
101     bool startRequest(QContactAbstractRequest* req);
102     bool waitForRequestFinished(QContactAbstractRequest* req, int msecs);
103
104     /* Capabilities reporting */
105     QMap<QString, QString> managerParameters() const;
106     QString managerName() const;
107     int managerVersion() const;
108
109     bool hasFeature(QContactManager::ManagerFeature feature, const QString& contactType) const;
110     bool isFilterSupported(const QContactFilter& filter) const;
111     QList<QVariant::Type> supportedDataTypes() const;
112     QStringList supportedContactTypes() const;
113
114     /* Synthesise the display label of a contact */
115     QString synthesizedDisplayLabel(const QContact& contact, QContactManager::Error* error) const;
116
117     /* XXX TODO: pure virtual unimplemented functions! */
118     QList<QContactRelationship> relationships(const QString&, const QContactId&, QContactRelationship::Role, QContactManager::Error* error) const;
119     bool saveRelationships(QList<QContactRelationship>*, QMap<int, QContactManager::Error>*, QContactManager::Error* error);
120     bool removeRelationships(const QList<QContactRelationship>&, QMap<int, QContactManager::Error>*, QContactManager::Error* error);
121     QContact compatibleContact(const QContact&, QContactManager::Error* error) const;
122     bool validateContact(const QContact&, QContactManager::Error* error) const;
123     bool validateDefinition(const QContactDetailDefinition&, QContactManager::Error* error) const;
124     bool saveDetailDefinition(const QContactDetailDefinition&, const QString&, QContactManager::Error* error);
125     bool removeDetailDefinition(const QString&, const QString&, QContactManager::Error* error);
126     bool cancelRequest(QContactAbstractRequest*);
127     bool isRelationshipTypeSupported(const QString&, const QString&) const;
128
129 private:
130     //called from both constructors, connecting to all contact NodeList changes signals
131     void connectToSignals();
132     QContact contactImpl(const QContactLocalId& contactId, const QContactFetchHint& fetchHint, QContactManager::Error* error) const;
133
134 private:
135     QSharedDataPointer<QContactTrackerEngineData> d;
136     friend class ut_qtcontacts_trackerplugin;
137 };
138
139 #endif // QTRACKERCONTACTENGINE_H