01: // The contents of this file are subject to the Mozilla Public License Version
02: // 1.1
03: //(the "License"); you may not use this file except in compliance with the
04: //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
05: //
06: //Software distributed under the License is distributed on an "AS IS" basis,
07: //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
08: //for the specific language governing rights and
09: //limitations under the License.
10: //
11: //The Original Code is "The Columba Project"
12: //
13: //The Initial Developers of the Original Code are Frederik Dietz and Timo
14: // Stich.
15: //Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003.
16: //
17: //All Rights Reserved.
18: package org.columba.addressbook.folder;
19:
20: import java.util.List;
21: import java.util.Map;
22:
23: import org.columba.addressbook.model.IContactModelPartial;
24: import org.columba.addressbook.model.IBasicModelPartial;
25: import org.columba.api.exception.StoreException;
26:
27: /**
28: * @author fdietz
29: *
30: */
31: public interface IContactFolder extends IContactStorage {
32: /**
33: * Adds a listener.
34: */
35: void addFolderListener(FolderListener l);
36:
37: /**
38: * Removes a previously registered listener.
39: */
40: void removeFolderListener(FolderListener l);
41:
42: /**
43: * Retrieve map of all contact items.
44: *
45: * @return never <code>null</code>
46: * @throws StoreException
47: */
48: Map<String, IContactModelPartial> getContactItemMap()
49: throws StoreException;
50:
51: /**
52: * Retrieve map of all specified contact items.
53: *
54: * @param ids <code>String</code> array of contact IDs
55: * @return never <code>null</code>
56: * @throws StoreException
57: */
58: Map<String, IContactModelPartial> getContactItemMap(String[] ids)
59: throws StoreException;
60:
61: /**
62: * save header-cache (HeaderItemList)
63: */
64: void save() throws StoreException;
65:
66: /**
67: * load header-cache (HeaderItemList)
68: */
69: void load() throws StoreException;
70:
71: /**
72: * Get all contact items of this folder.
73: */
74: List<IContactModelPartial> getHeaderItemList()
75: throws StoreException;
76: }
|