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 /**
25 * Provider for statistics. A provider may provide statistics for only one {@link ResourceType}, but for different
26 * {@link DataResolution}s. So e.g. there may be an "EpisodeViewsProvider" which provides the view counts of episodes
27 * on a daily, monthly, and yearly basis.
28 */
29 public interface StatisticsProvider {
30
31 /**
32 * @return The unique identifier of the provider.
33 */
34 String getId();
35
36 /**
37 * @return The type of resources this provider provides statistics for.
38 */
39 ResourceType getResourceType();
40
41 /**
42 * @return A title to display with the charts generated from the statistics provided by this provider. This should be
43 * a translation string key.
44 */
45 String getTitle();
46
47 /**
48 * @return A description to display with the charts generated from the statistics provided by this provider. This
49 * should be a translation string key.
50 */
51 String getDescription();
52 }