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

IssueTypeManager

com.atlassian.jira.config.IssueTypeManager
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 for IssueTypes.

Summary

Public Methods
@Deprecated IssueType createIssueType(String name, String description, String iconUrl)
This method is deprecated. Use createIssueType(String, String, Long) instead. Since v6.3.
IssueType createIssueType(String name, String description, Long avatarId)
Create a new (non-subtask) issue type.
IssueType createSubTaskIssueType(String name, String description, String iconUrl)
Create a new subtask issue type.
IssueType createSubTaskIssueType(String name, String description, Long avatarId)
Create a new subtask issue type.
@Deprecated void editIssueType(IssueType issueType, String name, String description, String iconUrl)
This method is deprecated. Use updateIssueType(com.atlassian.jira.issue.issuetype.IssueType, String, String, Long) instead. Since v6.3.
Collection<IssueType> getAvailableIssueTypes(IssueType issueType)
Returns a collection of suitable alternative IssueTypes to which issues with the supplied issue type can be moved to.
IssueType getIssueType(String id)
Returns the IssueType for the specified id.
Collection<IssueType> getIssueTypes()
Returns all issue types regular and subtask issue types.
boolean hasAssociatedIssues(IssueType issueType)
Checks if there are any issues associated with this issue type.
void removeIssueType(String id, String newIssueTypeId)
Removes an issue type.
void updateIssueType(IssueType issueType, String name, String description, Long avatarId)
Edits an existing issue type.

Public Methods

@Deprecated public IssueType createIssueType (String name, String description, String iconUrl)

This method is deprecated.
Use createIssueType(String, String, Long) instead. Since v6.3.

Create a new (non-subtask) issue type. The new issue type will be added to the default issue type scheme.

Parameters
name name of the issue type. Cannot be null or blank. Must be unique across issue types and subtask issue types.
description description for the issue type.
iconUrl icon URL for the issue type. Cannot be null or blank.
Returns

public IssueType createIssueType (String name, String description, Long avatarId)

Create a new (non-subtask) issue type. The new issue type will be added to the default issue type scheme.

After successful creation of the new issue type, this method publishes an instance of IssueTypeCreatedEvent.

Parameters
name name of the issue type. Cannot be null or blank. Must be unique across issue types and subtask issue types.
description description for the issue type.
avatarId avatarId for the issue type. Cannot by null.
Returns

public IssueType createSubTaskIssueType (String name, String description, String iconUrl)

Create a new subtask issue type. The new issue type will be added to the default issue type scheme.

Parameters
name name of the issue type. Cannot be null or blank. Must be unique across issue types and subtask issue types.
description description for the issue type.
iconUrl icon URL for the issue type. Cannot be null or blank.
Returns

public IssueType createSubTaskIssueType (String name, String description, Long avatarId)

Create a new subtask issue type. The new issue type will be added to the default issue type scheme.

Parameters
name name of the issue type. Cannot be null or blank. Must be unique across issue types and subtask issue types.
description description for the issue type.
avatarId avatarId for the issue type. Cannot by null.
Returns

@Deprecated public void editIssueType (IssueType issueType, String name, String description, String iconUrl)

This method is deprecated.
Use updateIssueType(com.atlassian.jira.issue.issuetype.IssueType, String, String, Long) instead. Since v6.3.

Edits an existing issue type.

Parameters
issueType existing issue type
name new name. Cannot be null or blank. Must be unique across issue types and subtask issue types.
description new description.
iconUrl icon URL for the issue type. Cannot be null or blank.

public Collection<IssueType> getAvailableIssueTypes (IssueType issueType)

Returns a collection of suitable alternative IssueTypes to which issues with the supplied issue type can be moved to. The suitable alternative IssueTypes will have to use the same workflow, the same field configuration and the same screen scheme.

Returns

public IssueType getIssueType (String id)

Returns the IssueType for the specified id.

Parameters
id issue type id.
Returns

public Collection<IssueType> getIssueTypes ()

Returns all issue types regular and subtask issue types.

Returns

public boolean hasAssociatedIssues (IssueType issueType)

Checks if there are any issues associated with this issue type.

Parameters
issueType for which issues are searched.
Returns
  • true if the issue type has any associated issues.

public void removeIssueType (String id, String newIssueTypeId)

Removes an issue type. All issues which use this issue type will be migrated to a different issue type which is specified in the second argument. After successful removal of an issue type, this method publishes an instance of IssueTypeDeletedEvent.

Parameters
id id of the issue type to remove
newIssueTypeId the id of the new issue type for all issues which are of the issue type which we are about to remove. Can be null.

public void updateIssueType (IssueType issueType, String name, String description, Long avatarId)

Edits an existing issue type. After successful update of an issue type, this method publishes an instance of IssueTypeUpdatedEvent.

Parameters
issueType existing issue type
name new name. Cannot be null or blank. Must be unique across issue types and subtask issue types.
description new description.
avatarId avatar id the issue type. Cannot be null or blank.