CsvDepositoryValuesResource.java

/**
 * CsvDepositoryValuesResource.java This file is part of WattDepot.
 *
 * Copyright (C) 2013  Brian Frølund
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.wattdepot.common.http.api;

import org.restlet.representation.StringRepresentation;
import org.restlet.resource.Get;

/**
 * CsvDepositoryValuesResource - HTTP Interface for getting the MeasuredValueList. <br>
 * (/wattdepot/{org-id}/depository/{depository-id}/values/csv/)
 * 
 * @author Brian Frølund
 * 
 */
@SuppressWarnings("PMD.UnusedModifier")
public interface CsvDepositoryValuesResource {

  /**
   * Defines GET <br>
   * /wattdepot/{org-id}/depository/{depository-id}/values/csv/?sensor={sensor_id}&start={start}&end={end}&interval={interval}.
   * 
   * @return Export csv data file.
   */
  @Get( value = "csv")
  public StringRepresentation retrieve();
}