Package com.polarion.alm.tracker.exporter

Interface IExportTemplate

public interface IExportTemplate
A template for export. Export templates can either be managed by the export manager and stored as file in the repository, or custom templates created using the export template factory for a particular export.
See Also:

  • Method Details

    • getContent

      @NotNull InputStream getContent()
      The content of the template. The content's type depends on the exporter used. The caller is responsible for closing the returned stream.

    • getExportFields

      @NotNull List<IExportConfiguration.IExportField> getExportFields(@NotNull IContextId contextId)
      Fields that are prescribed in the template for export. If the corresponding exporter does not support the export of the selected fields, (see IExporterDescriptor.getFieldExportCapability()), an empty list is returned.
      Parameters:
      contextId - The context where the template is used.
      Returns:
      The export fields prescribed in the template.
      Since:
      3.5.2

    • getLabel

      @Nullable String getLabel()
      The template's label. Can be null if this template is a custom template. (One that is not stored in a repository.)
      Returns:
      label
      Since:
      3.5.1

    • getName

      @Nullable String getName()
      The name of the template that serves as the ID. The name must be unique with the context of where it is used). Can be null if this template is a custom template. (One that is not stored in a repository.)

    • getLocation

      @Nullable ILocation getLocation()
      The location of the template within the repository. Returns null if this template is a custom template. (One that is not stored in a repository.)
      Returns:
      the location of the template.
      Since:
      3.3

    • getContextId

      @Nullable IContextId getContextId()
      Returns the context where the template is defined. Returns null if this template is a custom template. (One that is not stored in a repository.).
      Since:
      3.5.1