All Known Implementing Classes:
CCAbstractExporter

public interface ICCExporter
Since:
3.1
  • Method Details

    • getType

      String getType()
      The type of artifact exported. E.g. HTML, PDF
      Returns:
      a string that represents the type of exported artifact
    • getSettings

      ICCExporterSettings getSettings()
      The settings this exporter supports set to their defaults The actual type of the setting should be documented as part of the exporter
      Returns:
      ICCExporterSettings
    • exportResult

      ICCExporterInfo exportResult(ICCResult result, ICCExporterSettings settings, String destination, boolean logging) throws CCExportException
      Export the contents of the passed ICCResult to the destination path The actual format of the exported artifact(s) is determined by the exporter
      Parameters:
      result - to be exported
      settings - Optional settings can be passed to the exporter by creating a class that extends ICCExporterSettings
      destination - path or file to be produced
      logging - optional enable/disable
      Returns:
      ICCExporterInfo that contains information about the export
      Throws:
      CCExportException - exception thrown during export. The exception may contain more detail
    • exportResults

      ICCExporterInfo exportResults(ICCResult[] results, ICCExporterSettings settings, String destination, boolean logging) throws CCExportException
      Export the contents of the passed ICCResult or results The implementor can decide if passing 2 or more has special meaning. For example it might mean that if 2 results are passed then they are compared. The default implementation will call exportResult(ICCResult, ICCExporterSettings, String, boolean) for each result passed
      Parameters:
      results - 1 or more results as an array to be exported
      settings - Optional settings can be passed to the exporter by creating a class that extends ICCExporterSettings
      destination - path or file to be produced. If more than 1 result is passed then the file name may be modified to allow for multiple destination files
      logging - optional enable/disable
      Returns:
      ICCExporterInfo that contains information about the export
      Throws:
      CCExportException - exception thrown during export. The exception may contain more detail
      Since:
      9.0