View Javadoc

1   //////////////////////////////////////////////////////////////////////////////
2   // dexterIM - Instant Messaging Framework
3   // Copyright (C) 2003  Christoph Walcher
4   //
5   // This program is free software; you can redistribute it and/or modify
6   // it under the terms of the GNU General Public License as published by
7   // the Free Software Foundation; either version 2 of the License, or
8   // (at your option) any later version.
9   //
10  // This program is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  // GNU General Public License for more details.
14  //
15  // You should have received a copy of the GNU General Public License
16  // along with this program; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  //////////////////////////////////////////////////////////////////////////////
19  package net.sf.dexterim.core;
20  
21  /*** Represents a Instant Messaging Contact.
22   * @author Christoph Walcher
23   */
24  public interface Contact {
25    /*** Gets the ID (a unique ID of the Contact)
26     * @return Unique Contact ID
27     */
28    public Object getIdentity();
29  
30    /*** Gets the Friendly Name of the Contact. A FriendlyName is the
31     * human readable Name of a Contact instance. Also known as:
32     * <ul>
33     * <li>Nick
34     * </ul>
35     * @return The FriendlyName of this Contact
36     */
37    public String getFriendlyName();
38  
39    public ContactState getState();
40  
41    public void changeState(Object stateID);
42  }