net.anotheria.moskito.webui.accumulators.api.AccumulatorAPI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of moskito-webui Show documentation

There is a newer version: 4.0.3

package net.anotheria.moskito.webui.accumulators.api;

import net.anotheria.anoplass.api.API;
import net.anotheria.anoplass.api.APIException;
import net.anotheria.anoprise.metafactory.Service;
import org.distributeme.annotation.DistributeMe;
import org.distributeme.annotation.FailBy;
import org.distributeme.annotation.SupportService;
import org.distributeme.core.failing.RetryCallOnce;

import java.util.List;

/**
 * API Implementation for accumulators. Provides access to stored accumulators, their values and allows to create new.
 *
 */
@DistributeMe(agentsSupport=false)
@SupportService
@FailBy(strategyClass=RetryCallOnce.class)
public interface AccumulatorAPI extends API, Service {
	/**
	 * Creates a new accumulator from user input.
	 * @param formBean data for accumulator creation.
	 * @return
	 * @throws APIException
	 */
	AccumulatorDefinitionAO createAccumulator(AccumulatorPO formBean) throws APIException;

	/**
	 * Removes an eisting accumulator by its ids.
	 * @param id
	 * @throws APIException
	 */
	void removeAccumulator(String id) throws APIException;

	List getAccumulatorDefinitions() throws APIException;

	AccumulatorDefinitionAO getAccumulatorDefinition(String id) throws APIException;

	AccumulatedSingleGraphAO getAccumulatorGraphData(String id) throws APIException;

	AccumulatedSingleGraphAO getAccumulatorGraphDataByName(String name) throws APIException;

	AccumulatorAO getAccumulator(String id) throws APIException;

	AccumulatorAO getAccumulatorByName(String name) throws APIException;

	MultilineChartAO getNormalizedAccumulatorGraphData(List ids) throws APIException;

	MultilineChartAO getCombinedAccumulatorGraphData(List ids) throws APIException;

	List getChartsForMultipleAccumulators(List ids) throws APIException;

	/**
	 * Returns all accumulator ids which are tied to a specific producer.
	 * @param producerId
	 * @return
	 * @throws APIException
	 */
	List getAccumulatorIdsTiedToASpecificProducer(String producerId) throws APIException;

}