bzr branch
http://bzr.ed.am/android/import-contacts
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
1 |
/* |
2 |
* Backend.java |
|
3 |
* |
|
4 |
* Copyright (C) 2012 Tim Marston <tim@ed.am> |
|
5 |
* |
|
6 |
* This file is part of the Import Contacts program (hereafter referred |
|
7 |
* to as "this program"). For more information, see |
|
8 |
* http://ed.am/dev/android/import-contacts |
|
9 |
* |
|
10 |
* This program is free software: you can redistribute it and/or modify |
|
11 |
* it under the terms of the GNU General Public License as published by |
|
12 |
* the Free Software Foundation, either version 3 of the License, or |
|
13 |
* (at your option) any later version. |
|
14 |
* |
|
15 |
* This program is distributed in the hope that it will be useful, |
|
16 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
17 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
18 |
* GNU General Public License for more details. |
|
19 |
* |
|
20 |
* You should have received a copy of the GNU General Public License |
|
21 |
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
22 |
*/ |
|
23 |
||
24 |
package am.ed.importcontacts; |
|
25 |
||
26 |
import am.ed.importcontacts.Importer.ContactData; |
|
27 |
||
28 |
public interface Backend |
|
29 |
{ |
|
30 |
/** |
|
31 |
* Build-up our contacts cache, using contacts on the device. |
|
32 |
* @param cache the contacts cache to populate |
|
33 |
*/ |
|
34 |
public void populateCache( ContactsCache cache ); |
|
35 |
||
36 |
/** |
|
57
by edam
cleanup; fixed some typos; updated TODO |
37 |
* Delete a contact from the device. |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
38 |
* @param id of the contact to delete |
39 |
*/ |
|
40 |
public void deleteContact( Long id ); |
|
41 |
||
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
42 |
@SuppressWarnings("serial") |
43 |
public class ContactCreationException extends Exception { }; |
|
44 |
||
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
45 |
/** |
57
by edam
cleanup; fixed some typos; updated TODO |
46 |
* Add a contact to the device. |
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
47 |
* @param name name of the new contact, or null if there isn't one |
48 |
* @return the new contact's id |
|
49 |
* @throws ContactCreationException |
|
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
50 |
*/ |
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
51 |
public Long addContact( String name ) throws ContactCreationException; |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
52 |
|
53 |
/** |
|
57
by edam
cleanup; fixed some typos; updated TODO |
54 |
* Add a phone number to an existing contact on the device. |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
55 |
* @param id the existing contact's id |
56 |
* @param number the phone number |
|
57 |
* @param data data about the number |
|
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
58 |
* @throws ContactCreationException |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
59 |
*/ |
60 |
public void addContactPhone( Long id, String number, |
|
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
61 |
ContactData.PreferredDetail data ) throws ContactCreationException; |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
62 |
|
63 |
/** |
|
57
by edam
cleanup; fixed some typos; updated TODO |
64 |
* Add an email address to an existing contact on the device. |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
65 |
* @param id the existing contact's id |
66 |
* @param email the email address |
|
67 |
* @param data data about the email address |
|
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
68 |
* @throws ContactCreationException |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
69 |
*/ |
70 |
public void addContactEmail( Long id, String email, |
|
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
71 |
ContactData.PreferredDetail data ) throws ContactCreationException; |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
72 |
|
73 |
/** |
|
57
by edam
cleanup; fixed some typos; updated TODO |
74 |
* Add an address to an existing contact on the device. |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
75 |
* @param id the existing contact's id |
76 |
* @param address the address |
|
77 |
* @param data data about the address |
|
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
78 |
* @throws ContactCreationException |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
79 |
*/ |
80 |
public void addContactAddresses( Long id, String address, |
|
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
81 |
ContactData.TypeDetail data ) throws ContactCreationException; |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
82 |
|
83 |
/** |
|
57
by edam
cleanup; fixed some typos; updated TODO |
84 |
* Add a title and organisation to an existing contact on the device. |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
85 |
* @param id the existing contact's id |
86 |
* @param organisation the organisation |
|
87 |
* @param data data about the organisation |
|
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
88 |
* @throws ContactCreationException |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
89 |
*/ |
90 |
public void addContactOrganisation( Long id, String organisation, |
|
61
by edam
made contacts backend throw exceptions when it can't create contacts on the device; specified Locale in lower/upper case conversions; stripped old Contacts types from Importer (and replaced with our own types, which are now converted in the backend; switched using Integer() constructors to Integer.valueOf(); rewrote the main importer routine a bit |
91 |
ContactData.ExtraDetail data ) throws ContactCreationException; |
53
by edam
abstracted the android contacts API in to an interface, ready to be switched to |
92 |
} |