Package com.polarion.alm.tracker.exporter

Interface IExporterDescriptor

public interface IExporterDescriptor
Author:
Jiri Banszel, POLARION SOFTWARE

  • Method Details

    • getId

      String getId()

    • getLabel

      String getLabel()

    • getHint

      String getHint()
      Returns description of the export
      Since:
      3.1.2

    • getContentType

      String getContentType()

    • getFileName

      String getFileName()

    • getExportTypes

      Set<String> getExportTypes()
      Returns export types supported by this exporter. See constants "EXPORT_TYPE" in subinterfaces of IExportConfiguration.

    • isTemplateExporter

      boolean isTemplateExporter()
      Returns:
      true if export to template is supported by the exporter

    • isCharsetSelectable

      boolean isCharsetSelectable()
      Returns:
      if output charset is selectable by user
      Since:
      3.5.2

    • getFieldExportCapability

      IExporterDescriptor.IFieldExportCapability getFieldExportCapability()
      Returns null if this exporter does not export user selected fields (e.g. the fields can be prescribed by template).
      Returns:
      field export capability descriptor or null
      Since:
      3.5.2

    • getParameterDescriptors

      List getParameterDescriptors()
      Returns:
      list of IParameterDescriptor

    • isFieldsExporter

      @Deprecated boolean isFieldsExporter()
      Deprecated.
      use getFieldExportCapability()
      Returns:
      deprecated

    • canExportField

      @Deprecated boolean canExportField(String fieldId)
      Deprecated.
      use getFieldExportCapability()
      Returns:
      deprecated

    • isTreeExporter

      @Deprecated boolean isTreeExporter()
      Deprecated.
      use getExportTypes().contains(ITreeExportConfiguration.EXPORT_TYPE)
      Returns:
      true if export of work item tree is supported by the exporter