1 | /* |
2 | Copyright (c) 2008 Volker Krause <vkrause@kde.org> |
3 | |
4 | This library is free software; you can redistribute it and/or modify it |
5 | under the terms of the GNU Library General Public License as published by |
6 | the Free Software Foundation; either version 2 of the License, or (at your |
7 | option) any later version. |
8 | |
9 | This library is distributed in the hope that it will be useful, but WITHOUT |
10 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
11 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public |
12 | License for more details. |
13 | |
14 | You should have received a copy of the GNU Library General Public License |
15 | along with this library; see the file COPYING.LIB. If not, write to the |
16 | Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
17 | 02110-1301, USA. |
18 | */ |
19 | |
20 | #ifndef AKONADI_ITEMMOVEJOB_H |
21 | #define AKONADI_ITEMMOVEJOB_H |
22 | |
23 | #include <akonadi/job.h> |
24 | |
25 | namespace Akonadi { |
26 | |
27 | class Collection; |
28 | class Item; |
29 | class ItemMoveJobPrivate; |
30 | |
31 | /** |
32 | * @short Job that moves an item into a different collection in the Akonadi storage. |
33 | * |
34 | * This job takes an item and moves it to a collection in the Akonadi storage. |
35 | * |
36 | * @code |
37 | * |
38 | * Akonadi::Item item = ... |
39 | * Akonadi::Collection collection = ... |
40 | * |
41 | * Akonadi::ItemMoveJob *job = new Akonadi::ItemMoveJob( item, collection ); |
42 | * connect( job, SIGNAL(result(KJob*)), this, SLOT(moveResult(KJob*)) ); |
43 | * |
44 | * @endcode |
45 | * |
46 | * @author Volker Krause <vkrause@kde.org> |
47 | */ |
48 | class AKONADI_EXPORT ItemMoveJob : public Job |
49 | { |
50 | Q_OBJECT |
51 | |
52 | public: |
53 | /** |
54 | * Move the given item into the given collection. |
55 | * |
56 | * @param item The item to move. |
57 | * @param destination The destination collection. |
58 | * @param parent The parent object. |
59 | */ |
60 | ItemMoveJob(const Item &item, const Collection &destination, QObject *parent = 0); |
61 | |
62 | /** |
63 | * Move the given items into @p destination. |
64 | * |
65 | * @param items A list of items to move. |
66 | * @param destination The destination collection. |
67 | * @param parent The parent object. |
68 | */ |
69 | ItemMoveJob(const QList<Item> &items, const Collection &destination, QObject *parent = 0); |
70 | |
71 | /** |
72 | * Move the given items from @p sourec to @p destination. |
73 | * |
74 | * @internal If the items are identified only by RID, then you MUST use this |
75 | * constructor to specify the source collection, otherwise the job will fail. |
76 | * RID-based moves are only allowed to resources. |
77 | * |
78 | * @since 4.14 |
79 | */ |
80 | ItemMoveJob(const QList<Item> &items, const Collection &source, const Collection &destination, QObject *parent = 0); |
81 | |
82 | /** |
83 | * Destroys the item move job. |
84 | */ |
85 | ~ItemMoveJob(); |
86 | |
87 | /** |
88 | * Returns the destination collection. |
89 | * |
90 | * @since 4.7 |
91 | */ |
92 | Collection destinationCollection() const; |
93 | |
94 | /** |
95 | * Returns the list of items that where passed in the constructor. |
96 | * |
97 | * @since 4.7 |
98 | */ |
99 | QList<Item> items() const; |
100 | |
101 | protected: |
102 | void doStart(); |
103 | |
104 | private: |
105 | Q_DECLARE_PRIVATE(ItemMoveJob) |
106 | template <typename T, typename MoveJob> friend class MoveJobImpl; |
107 | }; |
108 | |
109 | } |
110 | |
111 | #endif |
112 | |