KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > addressbook > folder > IContactFolder


1 // The contents of this file are subject to the Mozilla Public License Version
2 // 1.1
3 //(the "License"); you may not use this file except in compliance with the
4 //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 //
6 //Software distributed under the License is distributed on an "AS IS" basis,
7 //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
8 //for the specific language governing rights and
9 //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 JavaDoc;
21 import java.util.Map JavaDoc;
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 JavaDoc<String JavaDoc, IContactModelPartial> getContactItemMap() throws StoreException;
49
50     /**
51      * Retrieve map of all specified contact items.
52      *
53      * @param ids <code>String</code> array of contact IDs
54      * @return never <code>null</code>
55      * @throws StoreException
56      */
57     Map JavaDoc<String JavaDoc, IContactModelPartial> getContactItemMap(String JavaDoc[] ids) throws StoreException;
58     
59     /**
60      * save header-cache (HeaderItemList)
61      */
62     void save() throws StoreException;
63
64     /**
65      * load header-cache (HeaderItemList)
66      */
67     void load() throws StoreException;
68
69     /**
70      * Get all contact items of this folder.
71      */
72     List JavaDoc<IContactModelPartial> getHeaderItemList() throws StoreException;
73 }
Popular Tags