Package io.jmix.reports.yarg.structure

Interface ReportTemplate

All Superinterfaces:
Serializable
All Known Implementing Classes:
ReportTemplate, ReportTemplateImpl
public interface ReportTemplate extends Serializable
This interface describes report template document.

  • Field Details

  • Method Details

    • getCode

      String getCode()

    • getDocumentName

      String getDocumentName()

    • getDocumentPath

      String getDocumentPath()

    • getDocumentContent

      InputStream getDocumentContent()
      Returns:
      stream containing resulting document

    • getOutputType

      ReportOutputType getOutputType()
      Returns:
      output type of for this template

    • getOutputNamePattern

      String getOutputNamePattern()
      Returns:
      name pattern for generating document. Example: ${Band1.FILE_NAME} or myDocument.doc

    • isGroovy

      default boolean isGroovy()
      Returns:
      if it is groovy html template.

    • isCustom

      boolean isCustom()
      Returns:
      if report is defined by custom class. In this case band data will be passed in io.jmix.reports.yarg.structure.ReportTemplate#getCustomReport() object and it will generate binary.

    • getCustomReport

      CustomReport getCustomReport()
      Returns:
      implementation of custom report logic.