/android/import-contacts

To get this branch, use:
bzr branch http://bzr.ed.am/android/import-contacts

« back to all changes in this revision

Viewing changes to src/am/ed/importcontacts/Backend.java

  • Committer: edam
  • Date: 2012-10-23 16:00:27 UTC
  • Revision ID: tim@ed.am-20121023160027-2jb0r4b4v78rewh1
updated TODO

Show diffs side-by-side

added added

removed removed

src/am/ed/importcontacts/Backend.java
1
1
/*
2
2
 * Backend.java
3
3
 *
4
 
 * Copyright (C) 2012 to 2013 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2012 Tim Marston <tim@ed.am>
5
5
 *
6
6
 * This file is part of the Import Contacts program (hereafter referred
7
 
 * to as "this program").  For more information, see
 
7
 * to as "this program"). For more information, see
8
8
 * http://ed.am/dev/android/import-contacts
9
9
 *
10
10
 * This program is free software: you can redistribute it and/or modify
21
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
22
 */
23
23
 
 
24
 
24
25
package am.ed.importcontacts;
25
26
 
26
27
import am.ed.importcontacts.Importer.ContactData;
27
28
 
 
29
 
28
30
public interface Backend
29
31
{
30
32
        /**
31
33
         * Build-up our contacts cache, using contacts on the device.
32
 
         *
33
34
         * @param cache the contacts cache to populate
34
35
         */
35
36
        public void populateCache( ContactsCache cache );
36
37
 
37
38
        /**
38
 
         * Delete a contact from the device.
39
 
         *
 
39
         * Delete a contact
40
40
         * @param id of the contact to delete
41
41
         */
42
42
        public void deleteContact( Long id );
43
43
 
44
 
        @SuppressWarnings("serial")
45
 
        public class ContactCreationException extends Exception { };
46
 
 
47
44
        /**
48
 
         * Add a contact to the device.
49
 
         *
50
 
         * @param name name of the new contact, or null if there isn't one
51
 
         * @return the new contact's id
52
 
         * @throws ContactCreationException
 
45
         * Add a contact
 
46
         * @param name name of the new contact
 
47
         * @return the new contact's id, or 0 on failure
53
48
         */
54
 
        public Long addContact( String name ) throws ContactCreationException;
 
49
        public Long addContact( String name );
55
50
 
56
51
        /**
57
 
         * Add a phone number to an existing contact on the device.
58
 
         *
 
52
         * Add a phone number to an existing contact
59
53
         * @param id the existing contact's id
60
54
         * @param number the phone number
61
55
         * @param data data about the number
62
 
         * @throws ContactCreationException
63
56
         */
64
57
        public void addContactPhone( Long id, String number,
65
 
                ContactData.PreferredDetail data ) throws ContactCreationException;
 
58
                ContactData.PreferredDetail data );
66
59
 
67
60
        /**
68
 
         * Add an email address to an existing contact on the device.
69
 
         *
 
61
         * Add an email address to an existing contact
70
62
         * @param id the existing contact's id
71
63
         * @param email the email address
72
64
         * @param data data about the email address
73
 
         * @throws ContactCreationException
74
65
         */
75
66
        public void addContactEmail( Long id, String email,
76
 
                ContactData.PreferredDetail data ) throws ContactCreationException;
 
67
                ContactData.PreferredDetail data );
77
68
 
78
69
        /**
79
 
         * Add an address to an existing contact on the device.
80
 
         *
 
70
         * Add an address to an existing contact
81
71
         * @param id the existing contact's id
82
72
         * @param address the address
83
73
         * @param data data about the address
84
 
         * @throws ContactCreationException
85
74
         */
86
75
        public void addContactAddresses( Long id, String address,
87
 
                ContactData.TypeDetail data ) throws ContactCreationException;
 
76
                ContactData.TypeDetail data );
88
77
 
89
78
        /**
90
 
         * Add a title and organisation to an existing contact on the device.
91
 
         *
 
79
         * Add a title and organisation to an existing contact
92
80
         * @param id the existing contact's id
93
81
         * @param organisation the organisation
94
82
         * @param data data about the organisation
95
 
         * @throws ContactCreationException
96
83
         */
97
84
        public void addContactOrganisation( Long id, String organisation,
98
 
                ContactData.ExtraDetail data ) throws ContactCreationException;
99
 
 
100
 
        /**
101
 
         * Add a note to an existing contact on the device.
102
 
         *
103
 
         * @param id the existing contact's id
104
 
         * @param note the note
105
 
         * @throws ContactCreationException
106
 
         */
107
 
        public void addContactNote( Long id, String note )
108
 
                throws ContactCreationException;
109
 
 
110
 
        /**
111
 
         * Add a birthday to an existing contact on the device.
112
 
         *
113
 
         * @param id the existing contact's id
114
 
         * @param birthday the birthday
115
 
         * @throws ContactCreationException
116
 
         */
117
 
        public void addContactBirthday( Long id, String birthday )
118
 
                throws ContactCreationException;
 
85
                ContactData.ExtraDetail data );
119
86
}