Package com.day.cq.reporting

Interface ConfigService

public interface ConfigService
This interface defines a configuration service for the reporting framework.

  • Method Details

    • getTimeZone

      TimeZone getTimeZone()
      Get the timezone to be used for any timebased calculation
      Returns:
      The timezone

    • getLocale

      Locale getLocale()
      Get the locale to be used for reporting
      Returns:
      The locale

    • getFirstDayOfWeek

      int getFirstDayOfWeek()
      Get the first day of a week (using the constants provided by Calendar).
      Returns:
      The first day of a week

    • getSnapshots

      String getSnapshots()
      Get the base path for snapshot data.
      Returns:
      The base path for snapshot data

    • getReportPath

      String getReportPath()
      Get the base path for reports.
      Returns:
      The base path for reports

    • getMaxRows

      Integer getMaxRows()
      Get the maximum number of rows persisted per snapshot.
      Returns:
      The maximum number of rows

    • getHourOfDay

      Integer getHourOfDay()
      Get the hour of day daily snapshots are taken.
      Returns:
      The hour of day daily snapshots are taken

    • getMinuteOfHour

      Integer getMinuteOfHour()
      Get the minute of hour hourly snapshots are taken
      Returns:
      The minute of hour hourly snapshots are taken

    • isFakeCreateAllowed

      boolean isFakeCreateAllowed()
      Determines if creating fake data (using FakeDataCreationServlet) is allowed. Fake data can only be created with admin session.
      Returns:
      true if creating fake data is allowed

    • getSnapshotUserId

      String getSnapshotUserId()
      Get the ID of the user historic snapshots are taken for.
      Returns:
      The user ID to create report snapshots for

    • enforceSnapshotUser

      boolean enforceSnapshotUser()
      Determines if snapshots are always taken for the user specified by getSnapshotUserId(), or if this user only works as a fallback if the user that finished the report is not available anymore.
      Returns:
      true if the user specified by getSnapshotUserId() is enforced for taking snapshots