@PublicApi public interface

ProjectTemplateManager

com.atlassian.jira.project.template.ProjectTemplateManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Manager to access project templates.

Summary

Public Methods
ProjectTemplate getDefaultTemplate()
Gets a default template that can be used to create a project.
Optional<ProjectTemplate> getProjectTemplate(ProjectTemplateKey projectTemplateKey)
Retrieves a project template by its key in the atlassian-plugin.xml.
List<ProjectTemplate> getProjectTemplates()
Get the list of Project Template for a given user within a given context

Public Methods

public ProjectTemplate getDefaultTemplate ()

Gets a default template that can be used to create a project.

Returns
  • The default template.

public Optional<ProjectTemplate> getProjectTemplate (ProjectTemplateKey projectTemplateKey)

Retrieves a project template by its key in the atlassian-plugin.xml.

Parameters
projectTemplateKey The key of the project template.
Returns
  • the requested project template

public List<ProjectTemplate> getProjectTemplates ()

Get the list of Project Template for a given user within a given context

Returns
  • The list of available project templates