Interface ScheduledReport

All Known Implementing Classes:
ScheduledReportJson
public interface ScheduledReport
A scheduled report definition in the Report Center (Reports v1 scheduledReport).

  • Method Details

    • getScheduledId

      String getScheduledId()
      Returns the scheduled report id.
      Returns:
      the scheduled report id (UUID)

    • getReportName

      String getReportName()
      Returns the report name.
      Returns:
      the report name

    • getScheduleType

      ReportScheduleType getScheduleType()
      Returns the schedule type (e.g. DAILY, WEEKLY, MONTHLY).
      Returns:
      the schedule type, or null if not provided

    • getPeriod

      ReportPeriod getPeriod()
      Returns the period (e.g. 30_DAYS, 1_DAY).
      Returns:
      the period, or null if not provided

    • getCreatedBy

      String getCreatedBy()
      Returns the person/entity who created this schedule.
      Returns:
      the creator, or null if not provided

    • getCreatedDate

      String getCreatedDate()
      Returns the time this schedule was first created.
      Returns:
      the created date, or null if not provided

    • getLastAttemptedDate

      String getLastAttemptedDate()
      Returns the last attempted date to trigger report generation.
      Returns:
      the last attempted date, or null if not provided

    • getCustomerOrganizationId

      Integer getCustomerOrganizationId()
      Returns the customer organization id.
      Returns:
      the customer organization id, or null if not provided

    • getForOrg

      Integer getForOrg()
      Returns the customer org id the report is generated on behalf of.
      Returns:
      the forOrg value, or null if not provided

    • getForUser

      String getForUser()
      Returns the user key the report is generated on behalf of.
      Returns:
      the forUser value, or null if not provided

    • getLastModifiedBy

      String getLastModifiedBy()
      Returns the person/entity who last modified this schedule.
      Returns:
      the last modifier, or null if not provided

    • getLastModifiedDate

      String getLastModifiedDate()
      Returns the last modified date of this schedule.
      Returns:
      the last modified date, or null if not provided

    • getNumberOfFailedAttempts

      Integer getNumberOfFailedAttempts()
      Returns the number of times report generation has failed.
      Returns:
      the failed-attempt count, or null if not provided

    • getStatus

      ReportScheduleStatus getStatus()
      Returns the schedule status (e.g. ACTIVE, INACTIVE).
      Returns:
      the status, or null if not provided

    • getParameters

      List<? extends ReportParameter> getParameters()
      Returns the parameters used to generate the reports.
      Returns:
      the parameters, or null if not provided

    • getReports

      List<? extends Report> getReports()
      Returns the reports generated from this schedule.
      Returns:
      the generated reports, or null if not provided