aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/service/googlecontacts/GoogleContactsEntry.java
blob: e72fe6786de326b94438f75d1ccda005eaf59d8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.java.sip.communicator.service.googlecontacts;

import java.util.*;

/**
 * Entry of Google Contacts directory.
 *
 * @author Sebastien Vincent
 */
public interface GoogleContactsEntry
{
    /**
     * The supported IM protocol
     */
    public enum IMProtocol
    {
        /**
         * Google Talk protocol.
         */
        GOOGLETALK,

        /**
         * AIM protocol.
         */
        AIM,

        /**
         * ICQ protocol.
         */
        ICQ,

        /**
         * Jabber protocol.
         */
        JABBER,

        /**
         * Skype protocol.
         */
        SKYPE,

        /**
         * Other protocol (i.e. not supported).
         */
        OTHER,
    }

    /**
     * Get the full name.
     *
     * @return full name
     */
    public String getFullName();

    /**
     * Get the family name.
     *
     * @return family name
     */
    public String getFamilyName();

    /**
     * Get the given name.
     *
     * @return given name
     */
    public String getGivenName();

    /**
     * Returns mails.
     *
     * @return mails
     */
    public List<String> getAllMails();

    /**
     * Adds a home mail address.
     *
     * @param mail the mail address
     */
    public void addHomeMail(String mail);

    /**
     * Returns home mail addresses.
     *
     * @return home mail addresses
     */
    public List<String> getHomeMails();

    /**
     * Adds a work mail address.
     *
     * @param mail the mail address
     */
    public void addWorkMails(String mail);

    /**
     * Returns work mail addresses.
     *
     * @return work mail addresses
     */
    public List<String> getWorkMails();

    /**
     * Returns telephone numbers.
     *
     * @return telephone numbers
     */
    public List<String> getAllPhones();

    /**
     * Adds a work telephone number.
     *
     * @param telephoneNumber the work telephone number
     */
    public void addWorkPhone(String telephoneNumber);

    /**
     * Returns work telephone numbers.
     *
     * @return work telephone numbers
     */
    public List<String> getWorkPhones();

    /**
     * Adds a mobile telephone numbers.
     *
     * @param telephoneNumber the mobile telephone number
     */
    public void addMobilePhone(String telephoneNumber);

    /**
     * Returns mobile telephone numbers.
     *
     * @return mobile telephone numbers
     */
    public List<String> getMobilePhones();

    /**
     * Adds a home telephone numbers.
     *
     * @param telephoneNumber the home telephone number
     */
    public void addHomePhone(String telephoneNumber);

    /**
     * Returns home telephone numbers.
     *
     * @return home telephone numbers
     */
    public List<String> getHomePhones();

    /**
     * Get the photo full URI.
     *
     * @return the photo URI or null if there isn't
     */
    public String getPhoto();

    /**
     * Returns IM addresses.
     *
     * @return Map where key is IM address and value is IM protocol (MSN, ...)
     */
    public Map<String, IMProtocol> getIMAddresses();

    /**
     * Adds an IM address.
     *
     * @param imAddress IM address
     * @param protocol IM protocol
     */
    public void addIMAddress(String imAddress, IMProtocol protocol);
}