net.java.sip.communicator.service.callhistory
Interface CallHistoryQuery

All Known Implementing Classes:

CallHistoryQueryImpl

public interface CallHistoryQuery

The CallHistoryQuery corresponds to a query made to the CallHistoryService. It allows to be canceled, to listen for changes in the results and to obtain initial results if available.

Author:

Yana Stamcheva

Method Summary

void	addQueryListener(CallHistoryQueryListener l) Adds the given CallHistoryQueryListener to the list of listeners interested in query result changes.
void	cancel() Cancels this query.
Collection<CallRecord>	getCallRecords() Returns a collection of the initial results for this query.
String	getQueryString() Returns the query string, this query was created for.
void	removeQueryListener(CallHistoryQueryListener l) Removes the given CallHistoryQueryListener from the list of listeners interested in query result changes.

Method Detail

cancel

void cancel()

Cancels this query.

getQueryString

String getQueryString()

Returns the query string, this query was created for.

Returns:

the query string, this query was created for

getCallRecords

Collection<CallRecord> getCallRecords()

Returns a collection of the initial results for this query. It's up to the implementation to determine, which and how many the initial results would be.

This method is meant to be used in order to return first fast initial results and then notify interested parties of additional results through the CallHistoryQueryListener, which should improve user experience when waiting for results.

Returns:

a collection of the initial results for this query

addQueryListener

void addQueryListener(CallHistoryQueryListener l)

Adds the given CallHistoryQueryListener to the list of listeners interested in query result changes.

Parameters:

l - the CallHistoryQueryListener to add

removeQueryListener

void removeQueryListener(CallHistoryQueryListener l)

Removes the given CallHistoryQueryListener from the list of listeners interested in query result changes.

Parameters:

l - the CallHistoryQueryListener to remove