IHistory.java

/****************************************************************************
 * Copyright (c) 2004 Composent, Inc. and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Composent, Inc. - initial API and implementation
 *****************************************************************************/

package org.eclipse.ecf.presence.history;

import java.util.Date;

import org.eclipse.core.runtime.IAdaptable;

/**
 * Chat history information.
 */
public interface IHistory extends IAdaptable {
	
	/**
	 * Get the history lines between the given start and end dates (inclusive).
	 * 
	 * @param start the start Date to retrieve history lines for.  If <code>null</code>, all
	 * history lines up to the end date (if provided) are returned.  If not 
	 * <code>null</code>, then all history lines with date equal to or after the start
	 * date will be returned.
	 * 
	 * @param end the end Date to retrieve history lines for.  If <code>null</code>, all
	 * history for the partner associated with this history is provided.  If not <code>null</code>,
	 * then all history with date equal to or prior the end date will be returned.
	 * 
	 * @return IHistoryLine[] history lines between start and end date.  Will return empty
	 * array if no history lines matchinq query exist.  Will not return <code>null</code>.
	 */
	public IHistoryLine[] getHistoryLines(Date start, Date end);
	
	/**
	 * Clear lines from history.
	 * 
	 * @param start the start Date to delete history lines for.  If <code>null</code>, all
	 * history lines up to the end date (if provided) will be deleted.  If not 
	 * <code>null</code>, then all history lines with date equal to or after the start
	 * date will be deleted.
	 * 
	 * @param end the end Date to delete history lines for.  If <code>null</code>, all
	 * history for the partner associated with this history will be deleted.  If not <code>null</code>,
	 * then all history with date equal to or prior the end date will be deleted.
	 * 
	 * @return IHistoryLine[] of lines actually removed from history.  Will not be <code>null</code>,
	 * but may be an empty array.
	 */
    public IHistoryLine[] deleteHistoryLines(Date start, Date end);

}