1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.statistics.api;
23
24 import java.time.Instant;
25 import java.time.ZoneId;
26 import java.util.Set;
27
28 /**
29 * A provider which provied time series data.
30 */
31 public interface TimeSeriesProvider extends StatisticsProvider {
32
33 /**
34 * Get the time series data provided by this provider.
35 *
36 * @param resourceId
37 * The id to access the resource to get statistics for (e.g. episode Id, organization Id or series Id).
38 * @param from
39 * The start date to calculate the statistics for.
40 * @param to
41 * The end date to calculate the statistics for.
42 * @param resolution
43 * The resolution to get the statistics with.
44 * @param zoneId
45 * The timezone to use for date calculations.
46 * @return The time series data.
47 */
48 TimeSeries getValues(String resourceId, Instant from, Instant to, DataResolution resolution, ZoneId zoneId);
49
50
51 /**
52 * @return A set of {@link DataResolution}s supported by this provider.
53 */
54 Set<DataResolution> getDataResolutions();
55 }