org.eclipse.ecf.presence.history
Interface IHistory

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

public interface IHistory
extends org.eclipse.core.runtime.IAdaptable

Chat history information.

Method Summary

IHistoryLine[]	deleteHistoryLines(java.util.Date start, java.util.Date end) Clear lines from history.
IHistoryLine[]	getHistoryLines(java.util.Date start, java.util.Date end) Get the history lines between the given start and end dates (inclusive).

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getHistoryLines

IHistoryLine[] getHistoryLines(java.util.Date start,
                               java.util.Date end)

Get the history lines between the given start and end dates (inclusive).

Parameters:

start - the start Date to retrieve history lines for. If null, all history lines up to the end date (if provided) are returned. If not null, then all history lines with date equal to or after the start date will be returned.

end - the end Date to retrieve history lines for. If null, all history for the partner associated with this history is provided. If not null, then all history with date equal to or prior the end date will be returned.

Returns:

IHistoryLine[] history lines between start and end date. Will return empty array if no history lines matchinq query exist. Will not return null.

deleteHistoryLines

IHistoryLine[] deleteHistoryLines(java.util.Date start,
                                  java.util.Date end)

Clear lines from history.

Parameters:

start - the start Date to delete history lines for. If null, all history lines up to the end date (if provided) will be deleted. If not null, then all history lines with date equal to or after the start date will be deleted.

end - the end Date to delete history lines for. If null, all history for the partner associated with this history will be deleted. If not null, then all history with date equal to or prior the end date will be deleted.

Returns:

IHistoryLine[] of lines actually removed from history. Will not be null, but may be an empty array.