Package org.opencastproject.usertracking.api

Interface Report

public interface Report
A class that represents a report

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(ReportItem reportItem)
    Add an report item to the report
    Calendar
    getFrom()
    Gets the date the data of the report starts from
    int
    getLimit()
    Gets the maximum number of report items of the report (used for paging)
    int
    getOffset()
    Gets the number of the report item to start with in the list of all report items (used for paging)
    long
    getPlayed()
    Gets the sum of the number of played seconds of all report items
    Calendar
    getTo()
    Gets the date the data of the report is referring to
    int
    getTotal()
    Gets the total of report items
    int
    getViews()
    Gets the sum of views of all report items
    void
    setFrom(Calendar from)
    Sets the the date the data of the report starts from
    void
    setLimit(int limit)
    Sets the maximum number of report items of the report (used for paging)
    void
    setOffset(int offset)
    Sets the number of the report item to start with in the list of all report items (used for paging)
    void
    setPlayed(long played)
    Sets the sum of the number of played seconds of all report items
    void
    setTo(Calendar to)
    Sets the date the data of the report is referring to
    void
    setTotal(int total)
    Sets the total of report items
    void
    setViews(int views)
    Sets the sum of views of all report items

  • Method Details

    • setFrom

      void setFrom(Calendar from)
      Sets the the date the data of the report starts from
      Parameters:
      from -

    • setTo

      void setTo(Calendar to)
      Sets the date the data of the report is referring to
      Parameters:
      to -

    • setViews

      void setViews(int views)
      Sets the sum of views of all report items
      Parameters:
      views -

    • setPlayed

      void setPlayed(long played)
      Sets the sum of the number of played seconds of all report items
      Parameters:
      played -

    • setTotal

      void setTotal(int total)
      Sets the total of report items
      Parameters:
      total -

    • setLimit

      void setLimit(int limit)
      Sets the maximum number of report items of the report (used for paging)
      Parameters:
      limit -

    • setOffset

      void setOffset(int offset)
      Sets the number of the report item to start with in the list of all report items (used for paging)
      Parameters:
      offset -

    • add

      void add(ReportItem reportItem)
      Add an report item to the report
      Parameters:
      reportItem -

    • getFrom

      Calendar getFrom()
      Gets the date the data of the report starts from
      Returns:

    • getTo

      Calendar getTo()
      Gets the date the data of the report is referring to
      Returns:

    • getViews

      int getViews()
      Gets the sum of views of all report items
      Returns:

    • getPlayed

      long getPlayed()
      Gets the sum of the number of played seconds of all report items
      Returns:

    • getTotal

      int getTotal()
      Gets the total of report items
      Returns:

    • getLimit

      int getLimit()
      Gets the maximum number of report items of the report (used for paging)
      Returns:

    • getOffset

      int getOffset()
      Gets the number of the report item to start with in the list of all report items (used for paging)
      Returns: