net.java.sip.communicator.service.contactsource
Interface ContactSourceService

All Known Subinterfaces:

ExtendedContactSourceService

All Known Implementing Classes:

AsyncContactSourceService, CallHistoryContactSource, GoogleContactsSourceService, LdapContactSourceService, MacOSXAddrBookContactSourceService, MsOutlookAddrBookContactSourceService

public interface ContactSourceService

The ContactSourceService interface is meant to be implemented by modules supporting large lists of contacts and wanting to enable searching from other modules.

Author:

Yana Stamcheva

Field Summary

static String

CALL_HISTORY Constants to identify ContactSource in call history.

Method Summary

String	getDisplayName() Returns a user-friendly string that identifies this contact source.
String	getIdentifier() Returns the identifier of this contact source.
ContactQuery	queryContactSource(String queryString) Queries this search source for the given queryString.
ContactQuery	queryContactSource(String queryString, int contactCount) Queries this search source for the given queryString.

Field Detail

CALL_HISTORY

static final String CALL_HISTORY

Constants to identify ContactSource in call history.

See Also:

Constant Field Values

Method Detail

getIdentifier

String getIdentifier()

Returns the identifier of this contact source. Some of the common identifiers are defined here (For example the CALL_HISTORY identifier should be returned by all call history implementations of this interface)

Returns:

the identifier of this contact source

getDisplayName

String getDisplayName()

Returns a user-friendly string that identifies this contact source.

Returns:

the display name of this contact source

queryContactSource

ContactQuery queryContactSource(String queryString)

Queries this search source for the given queryString.

Parameters:

queryString - the string to search for

Returns:

the created query

queryContactSource

ContactQuery queryContactSource(String queryString,
                                int contactCount)

Queries this search source for the given queryString.

Parameters:

queryString - the string to search for

contactCount - the maximum count of result contacts

Returns:

the created query