Summary: Methods | [Expand All]
@PublicApi public interface

IssueTypeTemplate

com.atlassian.jira.project.template.hook.IssueTypeTemplate
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

An issue type template used for Project Template configuration.

Summary

Public Methods
Optional<String> avatar()
Returns the file name of the avatar that should be used for this issue type.
String description()
Returns the description of the issue type.
String iconPath()
Returns the icon path of the issue type.
URL iconUrl()
Returns the icon url of the issue type.
boolean isSubtask()
Indicates whether this is a sub-task.
String key()
Returns the template key of the issue type.
String name()
Returns the name of the issue type.
Optional<String> screenScheme()
Returns the name of the screen scheme.
String style()
Returns the Issue Type Style.
Optional<String> workflow()
Returns the key of the associated workflow.

Public Methods

public Optional<String> avatar ()

Returns the file name of the avatar that should be used for this issue type. If an avatar is specified and exists it should be used instead of an icon.

Returns
  • The file name of the avatar.

public String description ()

Returns the description of the issue type.

Returns
  • the description

public String iconPath ()

Returns the icon path of the issue type.

Returns
  • the icon path

public URL iconUrl ()

Returns the icon url of the issue type.

Returns
  • the icon url

public boolean isSubtask ()

Indicates whether this is a sub-task.

Returns
  • whether this is a sub-task

public String key ()

Returns the template key of the issue type.

Returns
  • the key of the issue type

public String name ()

Returns the name of the issue type.

Returns
  • the name

public Optional<String> screenScheme ()

Returns the name of the screen scheme.

Returns
  • The name of the screen scheme.

public String style ()

Returns the Issue Type Style. This is empty by default which refers to a Standard Issue Type.

Returns
  • the issue type style

public Optional<String> workflow ()

Returns the key of the associated workflow.

Returns
  • the workflow key