net.java.sip.communicator.service.history
Interface InteractiveHistoryReader

All Known Implementing Classes:

InteractiveHistoryReaderImpl

public interface InteractiveHistoryReader

The InteractiveHistoryReader allows to search in the history in an interactive way, i.e. be able to cancel the search at any time and track the results through a HistoryQueryListener.

Author:

Yana Stamcheva

Method Summary

HistoryQuery	findByKeyword(String keyword, String field, int recordCount) Searches the history for all records containing the keyword.
HistoryQuery	findByKeywords(String[] keywords, String field, int recordCount) Searches the history for all records containing all keywords.

Method Detail

findByKeywords

HistoryQuery findByKeywords(String[] keywords,
                            String field,
                            int recordCount)

Searches the history for all records containing all keywords.

Parameters:

keywords - array of keywords we search for

field - the field where to look for the keyword

recordCount - limits the result to this record count

Returns:

a HistoryQuery object allowing to track this query

Throws:

RuntimeException - Thrown if an exception occurs during the execution of the query, such as internal IO error.

findByKeyword

HistoryQuery findByKeyword(String keyword,
                           String field,
                           int recordCount)

Searches the history for all records containing the keyword.

Parameters:

keyword - the keyword to search for

field - the field where to look for the keyword

recordCount - limits the result to this record count

Returns:

a HistoryQuery object allowing to track this query

Throws:

RuntimeException - Thrown if an exception occurs during the execution of the query, such as internal IO error.