src/net/java/sip/communicator/impl/gui/main/contactlist/ContactListSourceFilter.java


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

/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.impl.gui.main.contactlist;

import java.util.*;

import net.java.sip.communicator.impl.gui.main.contactlist.contactsource.*;
import net.java.sip.communicator.service.contactsource.*;
import net.java.sip.communicator.service.gui.*;

/**
 * The <tt>ContactListSourceFilter</tt> is a <tt>ContactListFilter</tt> that
 * allows to apply the filter to only one of its contact sources at a time.
 *
 * @author Yana Stamcheva
 */
public interface ContactListSourceFilter
    extends ContactListFilter
{
    /**
     * Applies this filter to the given <tt>contactSource</tt>.
     *
     * @param contactSource the <tt>ExternalContactSource</tt> to apply the
     * filter to
     * @return the <tt>ContactQuery</tt> that tracks this filter
     */
    public ContactQuery applyFilter(ExternalContactSource contactSource);

    /**
     * Returns the list of current <tt>ExternalContactSource</tt>s this filter
     * works with.
     * @return the list of current <tt>ExternalContactSource</tt>s this filter
     * works with
     */
    public Collection<ExternalContactSource> getContactSources();

    /**
     * Indicates if this filter contains a default source.
     * @return <tt>true</tt> if this filter contains a default source,
     * <tt>false</tt> otherwise
     */
    public boolean hasDefaultSource();
}