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

All Known Implementing Classes:

HistoryImpl

public interface History

Author:

Alexander Pelov, Yana Stamcheva

Method Summary

HistoryRecordStructure	getHistoryRecordsStructure()
HistoryID	getID()
InteractiveHistoryReader	getInteractiveReader() Returns an object that can be used to read and query this history.
HistoryReader	getReader() Returns an object which can be used to read and query this history.
HistoryWriter	getWriter() Returns an object which can be used to append records to this history.
void	setHistoryRecordsStructure(HistoryRecordStructure structure) Sets the given structure to be the new history records structure used in this history implementation.

Method Detail

getReader

HistoryReader getReader()

Returns an object which can be used to read and query this history.

Returns:

an object which can be used to read and query this history

getInteractiveReader

InteractiveHistoryReader getInteractiveReader()

Returns an object that can be used to read and query this history. The InteractiveHistoryReader differs from the HistoryReader in the way it manages query results. It allows to cancel a search at any time and to track history results through a HistoryQueryListener.

Returns:

an object that can be used to read and query this history

getWriter

HistoryWriter getWriter()

Returns an object which can be used to append records to this history.

Returns:

an object which can be used to append records to this history

getID

HistoryID getID()

Returns:

Returns the ID of this history.

getHistoryRecordsStructure

HistoryRecordStructure getHistoryRecordsStructure()

Returns:

Returns the structure of the history records in this history.

setHistoryRecordsStructure

void setHistoryRecordsStructure(HistoryRecordStructure structure)

Sets the given structure to be the new history records structure used in this history implementation.

Parameters:

structure - the new HistoryRecordStructure to use