Interface Report

All Known Implementing Classes:
ReportJson
public interface Report
A generated report in the Report Center (Reports v1 downloadable-report for the list view, report for the detail view).

The list view (getReports) populates the downloadable-report fields; the detail view (getReportById) additionally populates the richer report fields (createdBy, createdDate, startTime, endTime, errorMessage, location, numberOfAttempts, parameters). Fields not present in a given response are null.

  • Method Details

    • getReportId

      String getReportId()
      Returns the unique identifier of the report.
      Returns:
      the report id (UUID)

    • getScheduledId

      String getScheduledId()
      Returns the scheduled report id this report was generated from.
      Returns:
      the scheduled id, or null if not provided

    • getReportName

      String getReportName()
      Returns the report name.
      Returns:
      the report name, or null if not provided

    • getFileName

      String getFileName()
      Returns the file name of the report.
      Returns:
      the file name, or null if not provided

    • getFileType

      FileType getFileType()
      Returns the file type of the report.
      Returns:
      the file type, or null if not provided

    • getFileSize

      Long getFileSize()
      Returns the size of the report in bytes.
      Returns:
      the file size, or null if not provided

    • getCreatedFor

      String getCreatedFor()
      Returns the person/entity this report was created for.
      Returns:
      the createdFor value, or null if not provided

    • getRequestedDate

      String getRequestedDate()
      Returns the time this report was first requested.
      Returns:
      the requested date, or null if not provided

    • getGeneratedDate

      String getGeneratedDate()
      Returns the time this report was generated.
      Returns:
      the generated date, or null if not provided

    • getStatus

      ReportStatus getStatus()
      Returns the report status.
      Returns:
      the status

    • getNumberOfDownloads

      Integer getNumberOfDownloads()
      Returns the number of times this report has been downloaded.
      Returns:
      the download count, or null if not provided

    • getCreatedBy

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

    • getCreatedDate

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

    • getStartTime

      String getStartTime()
      Returns the processing start time of the report (detail view only).
      Returns:
      the start time, or null if not provided

    • getEndTime

      String getEndTime()
      Returns the processing end time of the report (detail view only).
      Returns:
      the end time, or null if not provided

    • getErrorMessage

      String getErrorMessage()
      Returns an error message if report generation failed (detail view only).
      Returns:
      the error message, or null if not provided

    • getLocation

      String getLocation()
      Returns the location of the report once generated (detail view only).
      Returns:
      the location, or null if not provided

    • getNumberOfAttempts

      Integer getNumberOfAttempts()
      Returns the number of attempts made to generate the report (detail view only).
      Returns:
      the attempt count, or null if not provided

    • getLastAccessedBy

      String getLastAccessedBy()
      Returns the person/entity who accessed this report last (detail view only).
      Returns:
      the last accessor, or null if not provided

    • getLastAccessedDate

      String getLastAccessedDate()
      Returns the time this report was last accessed (detail view only).
      Returns:
      the last accessed date, or null if not provided

    • getPublisherInfo

      Map<String,Object> getPublisherInfo()
      Returns the report publish data as a free-form JSON object (detail view only). The Reports v1 spec declares no concrete properties for this object.
      Returns:
      the publisher info, or null if not provided

    • getParameters

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