|
1 /* |
|
2 * Copyright (c) 2002 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: Presence Attribute List manager abstract interface |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef __MPENGATTRIBUTELISTMANAGER_H__ |
|
21 #define __MPENGATTRIBUTELISTMANAGER_H__ |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32base.h> |
|
25 |
|
26 // Attribute list model |
|
27 #include "MPEngAttributeList2.h" |
|
28 |
|
29 /** |
|
30 * Presence Attribute List manager abstract interface |
|
31 * |
|
32 * This interface is used by the Presence Manager to retrieve attribute lists |
|
33 * and store them after editing then. |
|
34 * |
|
35 * @lib PEngListLib2 |
|
36 * @since 3.0 |
|
37 */ |
|
38 class MPEngAttributeListManager |
|
39 { |
|
40 |
|
41 public: // new public functions |
|
42 |
|
43 /** |
|
44 * Close reference to the Class |
|
45 * |
|
46 * @since 3.0 |
|
47 */ |
|
48 virtual void Close() = 0; |
|
49 |
|
50 /** |
|
51 * Create Empty attribute list |
|
52 * |
|
53 * @since 3.0 |
|
54 * @return empty attribute list |
|
55 */ |
|
56 virtual MPEngAttributeList2* CreateEmptyAttributeListL() = 0; |
|
57 |
|
58 /** |
|
59 * Get default attribute list |
|
60 * |
|
61 * @since 3.0 |
|
62 * @param attribute list set |
|
63 * @return default attribute list |
|
64 */ |
|
65 virtual MPEngAttributeList2* GetDefaultAttributeListL( |
|
66 TPEngAttributeListsSet2 aAttrListsSet ) = 0; |
|
67 |
|
68 /** |
|
69 * Set new default attribute list |
|
70 * |
|
71 * @since 3.0 |
|
72 * @param aAttrList attribute list to be set as default |
|
73 */ |
|
74 virtual void SetAsDefaultAttributeListL( |
|
75 MPEngAttributeList2& aAttrList ) = 0; |
|
76 |
|
77 /** |
|
78 * Delete default attribute list |
|
79 * |
|
80 * @since 3.0 |
|
81 */ |
|
82 virtual void DeleteDefaultAttributeListL() = 0; |
|
83 |
|
84 /** |
|
85 * Get attribute list attached to the contact Id |
|
86 * |
|
87 * @since 3.0 |
|
88 * @param aContactId contact id |
|
89 * @param attribute list set |
|
90 * @return attribute list attached to contact Id |
|
91 */ |
|
92 virtual MPEngAttributeList2* GetAttributeListForUserL( |
|
93 const TDesC& aContactId, |
|
94 TPEngAttributeListsSet2 aAttrListsSet ) = 0; |
|
95 |
|
96 /** |
|
97 * Get attribute list attached to the contact list |
|
98 * |
|
99 * @since 3.0 |
|
100 * @param aContactList contact list |
|
101 * @param attribute list set |
|
102 * @return attribute list attached to contact list |
|
103 */ |
|
104 virtual MPEngAttributeList2* GetAttributeListForContactListL( |
|
105 const TDesC& aContactList, |
|
106 TPEngAttributeListsSet2 aAttrListsSet ) = 0; |
|
107 |
|
108 /** |
|
109 * Attach attribute list to the contact list |
|
110 * |
|
111 * @since 3.0 |
|
112 * @param aContactList contact list to attach to |
|
113 * @param aAttrList attribute list to attach |
|
114 */ |
|
115 virtual void AttachAttributeListToContactListL( |
|
116 const TDesC& aContactList, |
|
117 MPEngAttributeList2& aAttrList ) = 0; |
|
118 |
|
119 /** |
|
120 * Attach attribute list to the contact id |
|
121 * |
|
122 * @since 3.0 |
|
123 * @param aContactId contact id to attach to |
|
124 * @param aAttrList attribute list to attach |
|
125 */ |
|
126 virtual void AttachAttributeListToUserL( |
|
127 const TDesC& aContactId, |
|
128 MPEngAttributeList2& aAttrList ) = 0; |
|
129 |
|
130 /** |
|
131 * Delete attribute list from Contact list |
|
132 * |
|
133 * @since 3.0 |
|
134 * @param aContactList contact list |
|
135 */ |
|
136 virtual void DeleteAttributeListFromContactListL( |
|
137 const TDesC& aContactList ) = 0; |
|
138 |
|
139 /** |
|
140 * Delete attribute list from Contact Id |
|
141 * |
|
142 * @since 3.0 |
|
143 * @param aContactId contact id |
|
144 */ |
|
145 virtual void DeleteAttributeListFromUserL( |
|
146 const TDesC& aContactId ) = 0; |
|
147 |
|
148 protected: |
|
149 /** |
|
150 * Protected Destructor. |
|
151 */ |
|
152 virtual ~MPEngAttributeListManager() {}; |
|
153 |
|
154 }; |
|
155 |
|
156 #endif // __MPENGATTRIBUTELISTMANAGER_H__ |
|
157 |
|
158 // End of File |