package rocks.inspectit.shared.cs.cmr.service;

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

import rocks.inspectit.shared.all.cmr.service.ServiceExporterType;
import rocks.inspectit.shared.all.cmr.service.ServiceInterface;
import rocks.inspectit.shared.all.communication.data.AggregatedExceptionSensorData;
import rocks.inspectit.shared.all.communication.data.ExceptionSensorData;
import rocks.inspectit.shared.cs.communication.comparator.ResultComparator;

/**
 * Service interface which defines the methods to retrieve data objects based on the exception
 * sensor recordings.
 *
 * @author Eduard Tudenhoefner
 *
 */
@ServiceInterface(exporter = ServiceExporterType.HTTP)
public interface IExceptionDataAccessService {

	/**
	 * Returns a list of {@link ExceptionSensorData} objects. This list can be used to get an
	 * ungrouped overview over recorded Exceptions in a target application.
	 *
	 * @param template
	 *            The template data object.
	 * @param limit
	 *            The limit/size of the list.
	 * @param resultComparator
	 *            Comparator that will be used to sort the results. Can be <code>null</code> and in
	 *            that case no sorting will be done.
	 * @return A list of {@link ExceptionSensorData} objects. This list can be used to get an
	 *         overview over recorded Exceptions in a target application.
	 */
	List<ExceptionSensorData> getUngroupedExceptionOverview(ExceptionSensorData template, int limit, ResultComparator<ExceptionSensorData> resultComparator);

	/**
	 * Returns a list of {@link ExceptionSensorData} objects which are between the from and to
	 * {@link Date} objects. This list can be used to get an overview over recorded Exceptions in a
	 * target application.
	 *
	 * @param template
	 *            The template data object.
	 * @param limit
	 *            The limit/size of the list.
	 * @param fromDate
	 *            The start date.
	 * @param toDate
	 *            The end date.
	 * @param resultComparator
	 *            Comparator that will be used to sort the results. Can be <code>null</code> and in
	 *            that case no sorting will be done.
	 * @return List of {@link ExceptionSensorData} objects to get an overview of recorded
	 *         Exceptions.
	 */
	List<ExceptionSensorData> getUngroupedExceptionOverview(ExceptionSensorData template, int limit, Date fromDate, Date toDate, ResultComparator<ExceptionSensorData> resultComparator);

	/**
	 * Returns a list of {@link ExceptionSensorData} objects. This list can be used to get an
	 * ungrouped overview over recorded Exceptions in a target application.
	 *
	 * @param template
	 *            The template data object.
	 * @param resultComparator
	 *            Comparator that will be used to sort the results. Can be <code>null</code> and in
	 *            that case no sorting will be done.
	 * @return A list of {@link ExceptionSensorData} objects. This list can be used to get an
	 *         overview over recorded Exceptions in a target application.
	 */
	List<ExceptionSensorData> getUngroupedExceptionOverview(ExceptionSensorData template, ResultComparator<ExceptionSensorData> resultComparator);

	/**
	 * Returns a list of {@link ExceptionSensorData} objects which are between the from and to
	 * {@link Date} objects. This list can be used to get an overview over recorded Exceptions in a
	 * target application.
	 *
	 * @param template
	 *            The template data object.
	 * @param fromDate
	 *            The start date.
	 * @param toDate
	 *            The end date.
	 * @param resultComparator
	 *            Comparator that will be used to sort the results. Can be <code>null</code> and in
	 *            that case no sorting will be done.
	 * @return List of {@link ExceptionSensorData} objects to get an overview of recorded
	 *         Exceptions.
	 */
	List<ExceptionSensorData> getUngroupedExceptionOverview(ExceptionSensorData template, Date fromDate, Date toDate, ResultComparator<ExceptionSensorData> resultComparator);

	/**
	 * Returns a list of {@link ExceptionSensorData} objects containing all details of a specific
	 * Exception class.
	 *
	 * @param template
	 *            The template object.
	 * @return List of {@link ExceptionSensorData} objects containing all details of a specific
	 *         Exception class.
	 */
	List<ExceptionSensorData> getExceptionTree(ExceptionSensorData template);

	/**
	 * Returns a list of {@link AggregatedExceptionSensorData} objects that is used to show an
	 * overview over Exceptions with specific information about the number of caused event types.
	 *
	 * @param template
	 *            The template object to be used for the query.
	 * @return A list of {@link AggregatedExceptionSensorData} objects with additional information
	 *         about how often a specific eventType was caused.
	 */
	List<AggregatedExceptionSensorData> getDataForGroupedExceptionOverview(ExceptionSensorData template);

	/**
	 * Returns a list of {@link AggregatedExceptionSensorData} objects that is used to show an
	 * overview over Exceptions with specific information about the number of caused event types.
	 * The returned list contains object that are between the from and to {@link Date} objects.
	 *
	 * @param template
	 *            The template object to be used for the query.
	 * @param fromDate
	 *            The start date.
	 * @param toDate
	 *            The end date.
	 * @return A list of {@link AggregatedExceptionSensorData} objects with additional information
	 *         about how often a specific eventType was caused.
	 */
	List<AggregatedExceptionSensorData> getDataForGroupedExceptionOverview(ExceptionSensorData template, Date fromDate, Date toDate);

	/**
	 * Returns the exception sensor data list for all error and stack message combinations for the
	 * throwable type defined in the template.
	 *
	 * @param template
	 *            template with throwable type set
	 * @return {@link ExceptionSensorData} list.
	 */
	List<ExceptionSensorData> getStackTraceMessagesForThrowableType(ExceptionSensorData template);
}