Package com.polarion.alm.projects

Interface IProjectTemplate

public interface IProjectTemplate
The template properties are specified in template.properties file in the template directory root. These keys are recognized:
  • name Template name
  • description Template description
  • parameters Names of parameters required for project creation. Separated by ';'. The parameter names might contain letters, '-' and '_'. The names are case sensitive.
  • skip List of files/directories to exclude from copy (template.properties is excluded automatically). Names do not start with '/'.
  • process List of text files where the parameters will be substituted during project creation (files are separated by ';'). Names do not start with '/'. In these files, occurences of %param-name% string will be replaced with the actual parameter value.
Author:
dobisekm

  • Method Details

    • getName

      String getName()

    • getDescription

      String getDescription()

    • getId

      String getId()

    • isDefault

      boolean isDefault()
      If true template is from module
      Returns:
      true if template is from module
      Since:
      3.5

    • getParametersIDs

      String getParametersIDs()
      Returns:
      parameter IDs in string or null if there are none
      Since:
      3.5

    • getParameters

      IProjectTemplate.Parameter[] getParameters()
      Returns the Parameters for this IProjectTemplate. The parameter names might contain letters, '-' and '_'. The names are case sensitive.
      Returns:
      the Parameters for this template

    • getDistributions

      Set<String> getDistributions()
      Get Set of distributions for this template
      Returns:
      Set of distributions, or empty Set if there are no distributions
      Since:
      3.5

    • isAvailableForCurrentUser

      boolean isAvailableForCurrentUser()
      Return available for current user
      Returns:
      true if current template licenses make it available for current user
      Since:
      3.5

    • getCustomIco

      String getCustomIco()
      Return name of custom ico included in template
      Returns:
      Name of ico, i.e. icon.png or null if no ico was found
      Since:
      3.5