|
1 /* |
|
2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Attribute Lists Transaction manager internal interface |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef __MPENGATTRIBUTELISTTRANSACTIONMANAGER_H__ |
|
19 #define __MPENGATTRIBUTELISTTRANSACTIONMANAGER_H__ |
|
20 |
|
21 // INCLUDES |
|
22 #include <e32base.h> |
|
23 #include <badesca.h> |
|
24 |
|
25 |
|
26 /** |
|
27 * Attribute Lists Transaction manager abstract interface |
|
28 * |
|
29 * This interface is used by the transaction to commit changes |
|
30 * after transaction was completed |
|
31 */ |
|
32 class MPEngAttributeListTransactionManager |
|
33 { |
|
34 public: |
|
35 /** |
|
36 * Commit attribute list creation. |
|
37 * It marks attribute list as created in the store. |
|
38 * |
|
39 * @since 3.0 |
|
40 * @param aAttrList attribute list to mark as synchronized |
|
41 */ |
|
42 virtual void AttributeListCreated( const RArray<TUint32>& aAttrList ) = 0; |
|
43 |
|
44 |
|
45 /** |
|
46 * Attribute list synchronized with the server |
|
47 * |
|
48 * @since 3.0 |
|
49 */ |
|
50 virtual void AttributeEngineSynchronizedL() = 0; |
|
51 |
|
52 |
|
53 /** |
|
54 * Commit successful creation of the attribute list for contact list |
|
55 * |
|
56 * @since 3.0 |
|
57 * @param aContact contact list which to commit |
|
58 */ |
|
59 virtual void CommitContactListL( const TDesC& aContactList ) = 0; |
|
60 |
|
61 |
|
62 /** |
|
63 * Commit successful creation of the attribute list for contact Id |
|
64 * |
|
65 * @since 3.0 |
|
66 * @param aContact Contact Id which to commit |
|
67 */ |
|
68 virtual void CommitContactIdL( const TDesC& aContactId ) = 0; |
|
69 |
|
70 |
|
71 /** |
|
72 * Rollback not successful creation of the attribute list |
|
73 * for contact list |
|
74 * |
|
75 * @since 3.0 |
|
76 * @param aContactList contact list which to rollback |
|
77 */ |
|
78 virtual void RollBackContactListL( const TDesC& aContactList ) = 0; |
|
79 |
|
80 |
|
81 /** |
|
82 * Rollback not successful creation of the attribute list for contact Id |
|
83 * |
|
84 * @since 3.0 |
|
85 * @param aContactId Contact Id which to rollback |
|
86 */ |
|
87 virtual void RollBackContactIdL( const TDesC& aContactId ) = 0; |
|
88 |
|
89 |
|
90 /** |
|
91 * Commit creation of the default attribute list |
|
92 * |
|
93 * @since 3.0 |
|
94 */ |
|
95 virtual void CommitDefaultL() = 0; |
|
96 |
|
97 /** |
|
98 * Roll back creattion of the default attribute list |
|
99 * |
|
100 * @since 3.0 |
|
101 */ |
|
102 virtual void RollBackDefaultL() = 0; |
|
103 |
|
104 |
|
105 /** |
|
106 * Commit contacts, creating of the attribute list was successful |
|
107 * |
|
108 * @since 3.0 |
|
109 * @param aContactLists list of contact lists |
|
110 * @param aContactIDs list of the contact IDs |
|
111 */ |
|
112 virtual void CommitDefinedContactsL( |
|
113 const CDesCArray* aContactLists, |
|
114 const CDesCArray* aContactIds ) = 0; |
|
115 |
|
116 /** |
|
117 * RollBack contacts. Rollbacks changes which were |
|
118 * not successfully commited on the server side |
|
119 * |
|
120 * @since 3.0 |
|
121 * @param aContactLists list of contact lists |
|
122 * @param aContactIDs list of the contact IDs |
|
123 */ |
|
124 virtual void RollBackDefinedContactsL( |
|
125 const CDesCArray* aContactLists, |
|
126 const CDesCArray* aContactIds ) = 0; |
|
127 |
|
128 /** |
|
129 * Store changes of the attribute list to the store |
|
130 * |
|
131 * @since 3.0 |
|
132 */ |
|
133 virtual void StoreChangesToStoreL() = 0; |
|
134 |
|
135 |
|
136 protected: |
|
137 /** |
|
138 * Protected destructor. |
|
139 */ |
|
140 virtual ~MPEngAttributeListTransactionManager() {}; |
|
141 |
|
142 }; |
|
143 |
|
144 #endif // __MPENGATTRIBUTELISTTRANSACTIONMANAGER_H__ |
|
145 |
|
146 // End of File |
|
147 |