ReportItem.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */

package org.opencastproject.usertracking.api;

/**
 * A class that represents a Report Item
 *
 */
public interface ReportItem {
  /**
   * Sets the episode id the report item is referring to
   *
   * @param episodeId
   */
  void setEpisodeId(String episodeId);

  /**
   * Sets the number of views of the episode
   *
   * @param views
   */
  void setViews(long views);

  /**
   * Sets the number of played seconds of the episode
   *
   * @param played
   */
  void setPlayed(long played);

  /**
   * Gets the episode id the report item is referring to
   *
   * @return
   */
  String getEpisodeId();

  /**
   * Get the number of views of the episode id
   *
   * @return
   */
  long getViews();

  /**
   * Gets the number of played seconds of the episode
   *
   * @return
   */
  long getPlayed();
}