IContactStorage


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 org.columba.addressbook.model.IContactModel;
21  import org.columba.api.exception.StoreException;
22  
23  /**
24   * Contact storage facility.
25   * 
26   * @author fdietz
27   * 
28   */
29  public interface IContactStorage extends IFolder {
30  
31      int count() throws StoreException;
32  
33      /**
34       * Find contact by email address. Search ignores case.
35       * 
36       * @param emailAddress
37       *            email address
38       * @return contact id, if match found. Otherwise, <code>null</code>
39       * @throws StoreException
40       */
41      String   findByEmailAddress(String   emailAddress) throws StoreException;
42  
43      /**
44       * Find contact by name. Search ignores case.
45       * <p>
46       * First tries to find a vCard "SORT_AS", then vCard "LASTNAME" and last
47       * vCard "FIRSTNAME", until a match is found. If several contacts match the
48       * first one is used and all other results are ignored.
49       * 
50       * @param name
51       *            email address
52       * @return contact id, if match found. Otherwise, <code>null</code>
53       * @throws StoreException
54       */
55      String   findByName(String   name) throws StoreException;
56  
57      boolean exists(String   id) throws StoreException;
58  
59      IContactModel get(String   id) throws StoreException;
60  
61      void remove(String   id) throws StoreException;
62  
63      void modify(String   id, IContactModel contact) throws StoreException;
64  
65      Object   add(IContactModel contact) throws StoreException;
66  
67      Object  [] add(IContactModel[] contacts) throws StoreException;
68  
69  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags