com.atlassian.jira.project.template.module

Class ProjectTemplateModule

java.lang.Object

com.atlassian.jira.project.template.module.ProjectTemplateModule

@Immutable
public class ProjectTemplateModule
extends Object

A project template module as defined in the atlassian-plugin.xml.

Since:

v2.14

Method Summary

Modifier and Type	Method and Description
AddProjectModule	addProjectModule() Returns the AddProjectModule.
Icon	backgroundIcon() Returns the backgroundIcon.
String	descriptionKey() Returns the descriptionKey.
String	getInfoSoyPath() Returns the path to the soy template which explains the template.
boolean	hasAddProjectModule() Returns whether an AddProjectModule is defined for this ProjectTemplateModule
Icon	icon() Returns the icon.
String	key() Returns this template module's complete key.
String	labelKey() Returns the labelKey.
Optional<String>	longDescriptionKey() Returns an optional longDescriptionKey.
String	projectTypeKey() Returns the key of the project type for projects created with this blueprint.
Integer	weight() Returns the weight.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

key

public String key()

Returns this template module's complete key. Format is "plugin.key:module.key".

Returns:

the template module key.

See Also:

ModuleDescriptor.getCompleteKey()

weight

public Integer weight()

Returns the weight.

Returns:

the weight

labelKey

public String labelKey()

Returns the labelKey.

Returns:

the labelKey

descriptionKey

public String descriptionKey()

Returns the descriptionKey.

Returns:

the descriptionKey

longDescriptionKey

public Optional<String> longDescriptionKey()

Returns an optional longDescriptionKey.

Returns:

the longDescriptionKey. Could be empty if none was supplied in the plugin module.

icon

public Icon icon()

Returns the icon.

Returns:

the icon

backgroundIcon

public Icon backgroundIcon()

Returns the backgroundIcon.

Returns:

the backgroundIcon

hasAddProjectModule

public boolean hasAddProjectModule()

Returns whether an AddProjectModule is defined for this ProjectTemplateModule

Returns:

whether AddProjectModule is defined

addProjectModule

public AddProjectModule addProjectModule()

Returns the AddProjectModule.

Returns:

the name of the AddProjectModule

getInfoSoyPath

public String getInfoSoyPath()

Returns the path to the soy template which explains the template.

Returns:

the path to information soy template.

projectTypeKey

public String projectTypeKey()

Returns the key of the project type for projects created with this blueprint.

Returns:

the key of the project type for projects created with this blueprint.