package rocks.inspectit.server.dao;

import java.util.Collection;
import java.util.Date;
import java.util.List;

import rocks.inspectit.shared.all.communication.DefaultData;
import rocks.inspectit.shared.all.communication.data.HttpTimerData;
import rocks.inspectit.shared.all.communication.data.JmxSensorValueData;

/**
 * All implementing classes of this interface are storing and retrieving the default data objects,
 * for example in the database.
 *
 * @author Patrice Bouillet
 *
 */
public interface DefaultDataDao {

	/**
	 * Persists or updates all items in the collection.
	 *
	 * @param defaultDataCollection
	 *            The collection with {@link DefaultData} objects to persist or update.
	 */
	void saveAll(List<? extends DefaultData> defaultDataCollection);

	/**
	 * Returns a list of stored {@link DefaultData} objects in the given interval, starting minus
	 * the passed timeInterval parameter to the current time.
	 *
	 * @param template
	 *            The template object to look for.
	 * @param timeInterval
	 *            The time interval to look for the objects. Ranging minus the passed time interval
	 *            parameter up until now.
	 * @return Returns a list of data objects which fulfill the criteria.
	 */
	List<DefaultData> findByExampleWithLastInterval(DefaultData template, long timeInterval);

	/**
	 * Search for data objects which have an ID greater than in the passed template object.
	 *
	 * @param template
	 *            The template object to look for with the ID used as the marker.
	 * @return Returns a list of data objects which fulfill the criteria.
	 */
	List<DefaultData> findByExampleSinceId(DefaultData template);

	/**
	 * Search for data objects which have an ID greater than in the passed template object. The
	 * Method Ident is always ignored.
	 *
	 * @param template
	 *            The template object to look for with the ID used as the marker.
	 * @return Returns a list of data objects which fulfill the criteria.
	 */
	List<DefaultData> findByExampleSinceIdIgnoreMethodId(DefaultData template);

	/**
	 * Search for data objects which are between the from and to {@link Date} object.
	 *
	 * @param template
	 *            The template object to look for.
	 * @param fromDate
	 *            The start date.
	 * @param toDate
	 *            The end date.
	 * @return Returns a list of data objects which fulfill the criteria.
	 */
	List<DefaultData> findByExampleFromToDate(DefaultData template, Date fromDate, Date toDate);

	/**
	 * Searches for the last saved data object.
	 *
	 * @param template
	 *            The template object to look for.
	 * @return Returns the last saved data object.
	 */
	DefaultData findByExampleLastData(DefaultData template);

	/**
	 * Returns the {@link HttpTimerData} list that can be used as the input for the plotting. From
	 * the template list the platfrom ident will be used as well as all URI and tagged values.
	 *
	 * @param templates
	 *            Templates.
	 * @param fromDate
	 *            From date.
	 * @param toDate
	 *            To date
	 * @param retrieveByTag
	 *            If tag values from the templates should be used when retrieving the data. If false
	 *            is passed, URi will be used from templates.
	 * @return List of {@link HttpTimerData}.
	 */
	List<HttpTimerData> getChartingHttpTimerDataFromDateToDate(Collection<HttpTimerData> templates, Date fromDate, Date toDate, boolean retrieveByTag);

	/**
	 * Returns the {@link JmxSensorValueData} list of a given time frame that can be used as partial
	 * input for the jmx sensor.
	 *
	 * @param jmxSensorValueData
	 *            The data.
	 * @param fromDate
	 *            From date.
	 * @param toDate
	 *            To date
	 * @return List of {@link JmxSensorValueData}.
	 */
	List<JmxSensorValueData> getJmxDataOverview(JmxSensorValueData jmxSensorValueData, Date fromDate, Date toDate);

	/**
	 * Deletes all default data objects in the database with the given platform ID.
	 *
	 * @param platformId
	 *            PLatform id of objects to be deleted.
	 */
	void deleteAll(Long platformId);

}