/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: Tim Marston
  • Date: 2013-10-20 17:51:32 UTC
  • Revision ID: tim@ed.am-20131020175132-lvqrbal1ztz5jepl
updated .bzrignore

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 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2012 to 2013 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
 
 
25
24
package am.ed.importcontacts;
26
25
 
27
26
import am.ed.importcontacts.Importer.ContactData;
28
27
 
29
 
 
30
28
public interface Backend
31
29
{
32
30
        /**
33
31
         * Build-up our contacts cache, using contacts on the device.
 
32
         *
34
33
         * @param cache the contacts cache to populate
35
34
         */
36
35
        public void populateCache( ContactsCache cache );
37
36
 
38
37
        /**
39
 
         * Delete a contact
 
38
         * Delete a contact from the device.
 
39
         *
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
 
44
47
        /**
45
 
         * Add a contact
46
 
         * @param name name of the new contact
47
 
         * @return the new contact's id, or 0 on failure
 
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
48
53
         */
49
 
        public Long addContact( String name );
 
54
        public Long addContact( String name ) throws ContactCreationException;
50
55
 
51
56
        /**
52
 
         * Add a phone number to an existing contact
 
57
         * Add a phone number to an existing contact on the device.
 
58
         *
53
59
         * @param id the existing contact's id
54
60
         * @param number the phone number
55
61
         * @param data data about the number
 
62
         * @throws ContactCreationException
56
63
         */
57
64
        public void addContactPhone( Long id, String number,
58
 
                ContactData.PreferredDetail data );
 
65
                ContactData.PreferredDetail data ) throws ContactCreationException;
59
66
 
60
67
        /**
61
 
         * Add an email address to an existing contact
 
68
         * Add an email address to an existing contact on the device.
 
69
         *
62
70
         * @param id the existing contact's id
63
71
         * @param email the email address
64
72
         * @param data data about the email address
 
73
         * @throws ContactCreationException
65
74
         */
66
75
        public void addContactEmail( Long id, String email,
67
 
                ContactData.PreferredDetail data );
 
76
                ContactData.PreferredDetail data ) throws ContactCreationException;
68
77
 
69
78
        /**
70
 
         * Add an address to an existing contact
 
79
         * Add an address to an existing contact on the device.
 
80
         *
71
81
         * @param id the existing contact's id
72
82
         * @param address the address
73
83
         * @param data data about the address
 
84
         * @throws ContactCreationException
74
85
         */
75
86
        public void addContactAddresses( Long id, String address,
76
 
                ContactData.TypeDetail data );
 
87
                ContactData.TypeDetail data ) throws ContactCreationException;
77
88
 
78
89
        /**
79
 
         * Add a title and organisation to an existing contact
 
90
         * Add a title and organisation to an existing contact on the device.
 
91
         *
80
92
         * @param id the existing contact's id
81
93
         * @param organisation the organisation
82
94
         * @param data data about the organisation
 
95
         * @throws ContactCreationException
83
96
         */
84
97
        public void addContactOrganisation( Long id, String organisation,
85
 
                ContactData.ExtraDetail data );
 
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;
86
119
}