org.eclipse.ecf.presence.history
Interface IHistoryManager

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

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

History manager for chat history.

Method Summary

IHistory	getHistory(ID targetID, java.util.Map options) Get history for given targetID.
boolean	isActive()
void	setActive(boolean active) Make this history manager active or inactive.

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

getAdapter

Method Detail

getHistory

IHistory getHistory(ID targetID,
                    java.util.Map options)

Get history for given targetID.

Parameters:

targetID - the ID of the targetID we want history for. May not be null. If being used for chat rooms, the targetID is the roomID for the desired history. if being used for IM/chat, the targetID is the ID of the chat partner.

options - any options associated with getting history info. May be null.

Returns:

IHistory for given partnerID. Will return null if no history exists (with given options) for the given targetID.

isActive

boolean isActive()

Returns:

true if history manager is active (recording history at all).

setActive

void setActive(boolean active)

Make this history manager active or inactive.

Parameters:

active - true to make this history manager active, false to make it inactive.