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

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

import rocks.inspectit.shared.all.cmr.model.PlatformIdent;
import rocks.inspectit.shared.all.cmr.service.ServiceExporterType;
import rocks.inspectit.shared.all.cmr.service.ServiceInterface;
import rocks.inspectit.shared.all.communication.DefaultData;
import rocks.inspectit.shared.all.communication.data.cmr.AgentStatusData;
import rocks.inspectit.shared.all.exception.BusinessException;

/**
 * Interface used to define all methods which clients (be it graphical/textual) can access the
 * stored information on the CMR.
 *
 * @author Patrice Bouillet
 *
 */
@ServiceInterface(exporter = ServiceExporterType.HTTP)
public interface IGlobalDataAccessService {

	/**
	 * Returns all the connected Agents of this CMR. The Map contains {@link PlatformIdent} objects
	 * with the current AgentStatusInfo.
	 * <p>
	 * Note that this method will not return the {@link PlatformIdent} with the complete tree of
	 * sensors and method idents, but only the general info about the Agent. If you need the
	 * complete sensor/method tree, please use the {@link #getCompleteAgent(long)} method.
	 *
	 * @return All connected Agents with it's statues. Note that it is possible that the status of
	 *         an agent is not available. Thus it is recommended to use the entry set of this map.
	 */
	Map<PlatformIdent, AgentStatusData> getAgentsOverview();

	/**
	 * Returns the platform ident with complete sensor/method tree.
	 * <p>
	 * IDs of available agents can be retrieved by executing {@link #getAgentsOverview()} method.
	 *
	 * @param id
	 *            Id of wanted agent.
	 * @return Agent with complete tree.
	 * @throws BusinessException
	 *             If given ID of the agent is not valid.
	 */
	PlatformIdent getCompleteAgent(long id) throws BusinessException;

	/**
	 * Deletes the Agent completely.
	 *
	 * @param platformId
	 *            Id of the Agent to be delete.
	 * @throws BusinessException
	 *             If Agent with provided ID does not exist or can not be deleted due to it's
	 *             connection status.
	 */
	void deleteAgent(long platformId) throws BusinessException;

	/**
	 * Returns the last saved data objects (with the given time interval). Returns a list of
	 * {@link DefaultData} objects.
	 *
	 * @param template
	 *            The template object used to identify which data should be loaded.
	 * @param timeInterval
	 *            The time interval.
	 * @return The last data objects.
	 */
	List<? extends DefaultData> getLastDataObjects(DefaultData template, long timeInterval);

	/**
	 * Returns the last saved data object.
	 *
	 * @param template
	 *            The template object used to identify which data should be loaded.
	 * @return The last data object.
	 */
	DefaultData getLastDataObject(DefaultData template);

	/**
	 * Returns all last saved data objects since the {@link DefaultData#getId()} stored in the
	 * template object.
	 *
	 * @param template
	 *            The template data object. The ID needs to be set.
	 * @return List of data objects.
	 */
	List<? extends DefaultData> getDataObjectsSinceId(DefaultData template);

	/**
	 * Returns all last saved data objects since the {@link DefaultData#getId()} stored in the
	 * template object. The only difference to the {@link #getDataObjectsSinceId(DefaultData)} is
	 * the fact that the method id is always ignored. Useful for sensor types like the SQL one where
	 * you don't care about the method being sensored.
	 *
	 * @param template
	 *            The template data object. The ID needs to be set.
	 * @return List of data objects.
	 */
	List<? extends DefaultData> getDataObjectsSinceIdIgnoreMethodId(DefaultData template);

	/**
	 * All data objects from the passed template in the given time range.
	 *
	 * @param template
	 *            The template data object.
	 * @param fromDate
	 *            The start date.
	 * @param toDate
	 *            The end date.
	 * @return List of data objects.
	 */
	List<? extends DefaultData> getDataObjectsFromToDate(DefaultData template, Date fromDate, Date toDate);

	/**
	 * All data objects from the passed templates in the given time range.
	 *
	 * @param templates
	 *            The templates objects. Return list will include all found data that matches the
	 *            templates.
	 * @param fromDate
	 *            The start date.
	 * @param toDate
	 *            The end date.
	 * @return List of data objects.
	 */
	List<? extends DefaultData> getTemplatesDataObjectsFromToDate(Collection<DefaultData> templates, Date fromDate, Date toDate);

}