KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > planetamessenger > mos > ui > JContactListInterface


1 /*
2     =========================================================================
3     Package ui - Implements user interface components
4  
5     This module is developed and maintained by PlanetaMessenger.org.
6     Specs, New and updated versions can be found in
7     http://www.planetamessenger.org
8     If you want contact the Team please send a email to Project Manager
9     Leidson Campos Alves Ferreira at leidson@planetamessenger.org
10
11     Copyright (C) since 2001 by PlanetaMessenger.org
12
13     This program is free software; you can redistribute it and/or modify
14     it under the terms of the GNU General Public License as published by
15     the Free Software Foundation; either version 2 of the License, or
16     (at your option) any later version.
17
18     This program is distributed in the hope that it will be useful,
19     but WITHOUT ANY WARRANTY; without even the implied warranty of
20     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21     GNU General Public License for more details.
22
23     You should have received a copy of the GNU General Public License
24     along with this program; if not, write to the Free Software
25     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26  
27     =========================================================================
28  */
29 /**
30  *
31  * $Id: JContactListInterface.java,v 1.2 2007/01/28 17:39:20 popolony2k Exp $
32  * $Author: popolony2k $
33  * $Name: $
34  * $Revision: 1.2 $
35  * $State: Exp $
36  *
37  */
38
39 package org.planetamessenger.mos.ui;
40
41 import org.planetamessenger.plugin.*;
42
43
44 public interface JContactListInterface {
45   
46   /**
47     * Called when user choose change the default language
48     **/
49   public void updateLanguage();
50   
51   /**
52     * Adds a item to the contact list.
53     * @param item The Item to add;
54     */
55   public boolean addItem( JContactListItem item );
56   
57   /**
58     * Returns the item specified by parameter.
59     * @param nPluginId The Plugin id;
60     * @param strItemId The id of Item to retrieve;
61     */
62   public JContactListItem getItem( int nPluginId, java.lang.String JavaDoc strItemId );
63   
64   /**
65     * Removes the item specified by parameter from Contact list.
66     * @param item The Item to remove;
67     */
68   public boolean removeItem( JContactListItem item );
69   
70   /**
71     * Removes all items from specified plugin.
72     * @param nPluginId The plugin id that whose plugins will be removed;
73     */
74   public boolean removePluginItems( int nPluginId );
75   
76   /**
77     * Set the status from all items of specified plugin.
78     * @param nPluginId The plugin id to set the new status
79     * for users;
80     * @nNewStatus The new status to set;
81     */
82   public boolean setAllItemsStatus( int nPluginId, int nNewStatus );
83   
84   /**
85     * Removes the selected item from Contact list.
86     */
87   public boolean removeSelectedItem();
88   
89   /**
90     * Sets a new status of contact list item specified by parameter.
91     * @param item The Item key to set the status;
92     * @param nNewStatus The new item status;
93     */
94   public boolean setItemStatus( JContactListItem item, int nNewStatus );
95
96   /**
97     * Restore the last status of a contact list item.
98     * @param item The Item key to set the status;
99     */
100   public void restoreItemStatus( JContactListItem item );
101 }
102
103 // JContactListInterface interface
104
Popular Tags