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.usertracking.api;
23
24 /**
25 * A class that represents a Report Item
26 *
27 */
28 public interface ReportItem {
29 /**
30 * Sets the episode id the report item is referring to
31 *
32 * @param episodeId
33 */
34 void setEpisodeId(String episodeId);
35
36 /**
37 * Sets the number of views of the episode
38 *
39 * @param views
40 */
41 void setViews(long views);
42
43 /**
44 * Sets the number of played seconds of the episode
45 *
46 * @param played
47 */
48 void setPlayed(long played);
49
50 /**
51 * Gets the episode id the report item is referring to
52 *
53 * @return
54 */
55 String getEpisodeId();
56
57 /**
58 * Get the number of views of the episode id
59 *
60 * @return
61 */
62 long getViews();
63
64 /**
65 * Gets the number of played seconds of the episode
66 *
67 * @return
68 */
69 long getPlayed();
70 }