com.atlassian.jira.config
Interface IssueTypeManager

All Known Implementing Classes:
DefaultIssueTypeManager

@PublicApi
public interface IssueTypeManager

Manager for IssueTypes.

Since:
v5.0

Method Summary
 IssueType createIssueType(String name, String description, Long avatarId)
          Create a new (non-subtask) issue type.
 IssueType createIssueType(String name, String description, String iconUrl)
          Deprecated. Use createIssueType(String, String, Long) instead. Since v6.3.
 IssueType createSubTaskIssueType(String name, String description, Long avatarId)
          Create a new subtask issue type.
 IssueType createSubTaskIssueType(String name, String description, String iconUrl)
          Create a new subtask issue type.
 void editIssueType(IssueType issueType, String name, String description, String iconUrl)
          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.
 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.
 

Method Detail

createIssueType

@Deprecated
IssueType createIssueType(String name,
                                     String description,
                                     String iconUrl)
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:
the new IssueType

createIssueType

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.

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:
the new IssueType
Since:
v6.3

createSubTaskIssueType

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:
the new IssueType

createSubTaskIssueType

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:
the new IssueType
Since:
v6.3

editIssueType

@Deprecated
void editIssueType(IssueType issueType,
                              String name,
                              String description,
                              String iconUrl)
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.

updateIssueType

void updateIssueType(IssueType issueType,
                     String name,
                     String description,
                     Long avatarId)
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.
avatarId - avatar id the issue type. Cannot be null or blank.
Since:
v6.3

getIssueTypes

Collection<IssueType> getIssueTypes()
Returns all issue types regular and subtask issue types.

Returns:
a collection of IssueTypes

removeIssueType

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.

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.

getIssueType

IssueType getIssueType(String id)
Returns the IssueType for the specified id.

Parameters:
id - issue type id.
Returns:
an IssueType

getAvailableIssueTypes

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.

Parameters:
issueType -
Returns:
a collection of IssueTypes


Copyright © 2002-2014 Atlassian. All Rights Reserved.