Package com.atlassian.jira.config

Class DefaultSubTaskManager

java.lang.Object

com.atlassian.jira.config.DefaultSubTaskManager

All Implemented Interfaces:

SubTaskManager

public class DefaultSubTaskManager
extends Object
implements SubTaskManager

Field Summary

Fields inherited from interface com.atlassian.jira.config.SubTaskManager

SUB_TASK_ISSUE_TYPE_STYLE, SUB_TASK_LINK_TYPE_INWARD_NAME, SUB_TASK_LINK_TYPE_NAME, SUB_TASK_LINK_TYPE_OUTWARD_NAME, SUB_TASK_LINK_TYPE_STYLE

Constructor Summary

Constructors

Constructor	Description
DefaultSubTaskManager(ConstantsManager constantsManager, IssueLinkTypeManager issueLinkTypeManager, IssueLinkManager issueLinkManager, PermissionManager permissionManager, ApplicationProperties applicationProperties, IssueTypeSchemeManager issueTypeSchemeManager, IssueManager issueManager, com.atlassian.event.api.EventPublisher eventPublisher, IssueTypeAuditHandler auditHandler)

Method Summary

Modifier and Type	Method	Description
IssueUpdateBean	changeParent(Issue subTask, Issue newParentIssue, ApplicationUser currentUser)	Change the parent of the given subtask to the given new parent on behalf of the given user.
void	createSubTaskIssueLink(Issue parentIssue, Issue subTaskIssue, ApplicationUser remoteUser)
void	disableSubTasks()
void	enableSubTasks()	Turn on sub-tasks by creating a sub-task issue link type and a default sub-task issue type
void	enableSubTasks(boolean createDefaultIfMissing)	Enables sub-tasks on the instance.
Collection<Long>	getAllSubTaskIssueIds()	Retrieves ids of all sub-task issues in the system.
Long	getParentIssueId(Issue issue)	Returns the parent issue ID of this the given issue.
Long	getParentIssueId(Long issueId)	Returns the parent issue ID of this the given issue.
Long	getParentIssueId(org.ofbiz.core.entity.GenericValue issue)	Returns the parent issue ID of this the given issue.
SubTaskBean	getSubTaskBean(Issue issue, ApplicationUser remoteUser)	Returns the SubTaskBean for the given parent issue in the context of the given user.
List<IssueLink>	getSubTaskIssueLinks(Long issueId)	Returns a list of issue links associated with the issue
IssueType	getSubTaskIssueType(String id)	Returns the SubTask IssueType with the given ID.
IssueType	getSubTaskIssueTypeById(String id)	Returns the SubTask IssueType with the given ID.
Collection<IssueType>	getSubTaskIssueTypeObjects()	Retrieves all the sub-task issue types
Collection<Issue>	getSubTaskObjects(Issue parentIssue)	Get an issue's subtasks.
Collection<Issue>	getVisibleSubTaskObjects(Issue issue, ApplicationUser currentUser)	Returns a collection of subtask issues for the given parent issue that are visible to the given user.
IssueType	insertSubTaskIssueType(String name, Long sequence, String description, Long avatarId)	Create new issue type and adds it to default scheme.
boolean	isSubTask(Issue issue)	Return true if the given issue is a subtask.
boolean	isSubTasksEnabled()
boolean	issueTypeExistsById(String id)
boolean	issueTypeExistsByName(String name)
void	moveSubTask(Issue parentIssue, Long currentSequence, Long sequence)
void	moveSubTaskIssueTypeDown(String id)
void	moveSubTaskIssueTypeUp(String id)
void	removeSubTaskIssueType(String name)
void	resetSequences(Issue issue)
void	updateSubTaskIssueType(String id, String name, Long sequence, String description, Long avatarId)	Update existing sub-task issue type.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSubTaskManager

public DefaultSubTaskManager(ConstantsManager constantsManager,
 IssueLinkTypeManager issueLinkTypeManager,
 IssueLinkManager issueLinkManager,
 PermissionManager permissionManager,
 ApplicationProperties applicationProperties,
 IssueTypeSchemeManager issueTypeSchemeManager,
 IssueManager issueManager,
 com.atlassian.event.api.EventPublisher eventPublisher,
 IssueTypeAuditHandler auditHandler)

Method Details

enableSubTasks

public void enableSubTasks()
                    throws CreateException

Turn on sub-tasks by creating a sub-task issue link type and a default sub-task issue type

Specified by:

enableSubTasks in interface SubTaskManager

Throws:

CreateException - if the default sub-task issue type creation failed.

enableSubTasks

public void enableSubTasks(boolean createDefaultIfMissing)
                    throws CreateException

Description copied from interface: SubTaskManager

Enables sub-tasks on the instance.

Specified by:

enableSubTasks in interface SubTaskManager

Parameters:

createDefaultIfMissing - if true and there are no sub-task issue types present, then the default sub-task issue type will be created.

Throws:

CreateException - if the default sub-task issue type creation failed.

disableSubTasks

public void disableSubTasks()

Specified by:

disableSubTasks in interface SubTaskManager

getSubTaskIssueTypeObjects

public Collection<IssueType> getSubTaskIssueTypeObjects()

Description copied from interface: SubTaskManager

Retrieves all the sub-task issue types

Specified by:

getSubTaskIssueTypeObjects in interface SubTaskManager

Returns:

A Collection of all sub-task IssueTypes.

isSubTasksEnabled

public boolean isSubTasksEnabled()

Specified by:

isSubTasksEnabled in interface SubTaskManager

insertSubTaskIssueType

public IssueType insertSubTaskIssueType(String name,
 Long sequence,
 String description,
 Long avatarId)
                                 throws CreateException

Description copied from interface: SubTaskManager

Create new issue type and adds it to default scheme.

Specified by:

insertSubTaskIssueType in interface SubTaskManager

Throws:

CreateException

updateSubTaskIssueType

public void updateSubTaskIssueType(String id,
 String name,
 Long sequence,
 String description,
 Long avatarId)
                            throws DataAccessException

Description copied from interface: SubTaskManager

Update existing sub-task issue type.

Specified by:

updateSubTaskIssueType in interface SubTaskManager

Throws:

DataAccessException

issueTypeExistsByName

public boolean issueTypeExistsByName(String name)

Specified by:

issueTypeExistsByName in interface SubTaskManager

moveSubTaskIssueTypeUp

public void moveSubTaskIssueTypeUp(String id)
                            throws DataAccessException

Specified by:

moveSubTaskIssueTypeUp in interface SubTaskManager

Throws:

DataAccessException

moveSubTaskIssueTypeDown

public void moveSubTaskIssueTypeDown(String id)
                              throws DataAccessException

Specified by:

moveSubTaskIssueTypeDown in interface SubTaskManager

Throws:

DataAccessException

getSubTaskIssueTypeById

public IssueType getSubTaskIssueTypeById(String id)

Description copied from interface: SubTaskManager

Returns the SubTask IssueType with the given ID.

Specified by:

getSubTaskIssueTypeById in interface SubTaskManager

Parameters:

id - the ID

Returns:

SubTask IssueType with the given ID.

getSubTaskIssueType

public IssueType getSubTaskIssueType(String id)

Description copied from interface: SubTaskManager

Returns the SubTask IssueType with the given ID.

Specified by:

getSubTaskIssueType in interface SubTaskManager

Parameters:

id - the ID

Returns:

SubTask IssueType with the given ID.

removeSubTaskIssueType

public void removeSubTaskIssueType(String name)
                            throws RemoveException

Specified by:

removeSubTaskIssueType in interface SubTaskManager

Throws:

RemoveException

issueTypeExistsById

public boolean issueTypeExistsById(String id)

Specified by:

issueTypeExistsById in interface SubTaskManager

isSubTask

public boolean isSubTask(Issue issue)

Description copied from interface: SubTaskManager

Return true if the given issue is a subtask.

Specified by:

isSubTask in interface SubTaskManager

Parameters:

issue - the issue

Returns:

true if the given issue is a subtask.

getParentIssueId

@Nullable
public Long getParentIssueId(org.ofbiz.core.entity.GenericValue issue)

Description copied from interface: SubTaskManager

Returns the parent issue ID of this the given issue. Will return null if the given issue is not a subtask.

Specified by:

getParentIssueId in interface SubTaskManager

Parameters:

issue - the issue

Returns:

the parent issue ID of this the given issue, or null.

getParentIssueId

@Nullable
public Long getParentIssueId(Issue issue)

Description copied from interface: SubTaskManager

Returns the parent issue ID of this the given issue. Will return null if the given issue is not a subtask.

Specified by:

getParentIssueId in interface SubTaskManager

Parameters:

issue - the issue

Returns:

the parent issue ID of this the given issue, or null.

See Also:

• SubTaskManager.getParentIssueId(Long)

getParentIssueId

@Nullable
public Long getParentIssueId(Long issueId)

Description copied from interface: SubTaskManager

Returns the parent issue ID of this the given issue. Will return null if the given issue is not a subtask.

Specified by:

getParentIssueId in interface SubTaskManager

Parameters:

issueId - the issue ID of the subtask

Returns:

the parent issue ID of this the given issue, or null.

See Also:

• SubTaskManager.getParentIssueId(Issue)

getVisibleSubTaskObjects

public Collection<Issue> getVisibleSubTaskObjects(Issue issue,
 ApplicationUser currentUser)

Description copied from interface: SubTaskManager

Returns a collection of subtask issues for the given parent issue that are visible to the given user. Visibility is determined by checking if the user has BROWSE permission for each subtask.

Specified by:

getVisibleSubTaskObjects in interface SubTaskManager

Parameters:

issue - the parent issue to get the subtasks for

currentUser - the user to check permissions for

Returns:

a collection of subtask issues that are visible to the given user

getSubTaskBean

public SubTaskBean getSubTaskBean(Issue issue,
 ApplicationUser remoteUser)

Description copied from interface: SubTaskManager

Returns the SubTaskBean for the given parent issue in the context of the given user.

Specified by:

getSubTaskBean in interface SubTaskManager

Parameters:

issue - the Issue

remoteUser - the user

Returns:

the SubTaskBean for the given parent issue in the context of the given user.

moveSubTask

public void moveSubTask(Issue parentIssue,
 Long currentSequence,
 Long sequence)

Specified by:

moveSubTask in interface SubTaskManager

resetSequences

public void resetSequences(Issue issue)

Specified by:

resetSequences in interface SubTaskManager

getAllSubTaskIssueIds

public Collection<Long> getAllSubTaskIssueIds()

Retrieves ids of all sub-task issues in the system.

Specified by:

getAllSubTaskIssueIds in interface SubTaskManager

getSubTaskIssueLinks

public List<IssueLink> getSubTaskIssueLinks(Long issueId)

Description copied from interface: SubTaskManager

Returns a list of issue links associated with the issue

Specified by:

getSubTaskIssueLinks in interface SubTaskManager

Parameters:

issueId - issue id

Returns:

a list of issue links

getSubTaskObjects

public Collection<Issue> getSubTaskObjects(Issue parentIssue)

Get an issue's subtasks.

Specified by:

getSubTaskObjects in interface SubTaskManager

Returns:

A collection of Issues.

createSubTaskIssueLink

public void createSubTaskIssueLink(Issue parentIssue,
 Issue subTaskIssue,
 ApplicationUser remoteUser)
                            throws CreateException

Specified by:

createSubTaskIssueLink in interface SubTaskManager

Throws:

CreateException

changeParent

public IssueUpdateBean changeParent(Issue subTask,
 Issue newParentIssue,
 ApplicationUser currentUser)
                             throws RemoveException,
CreateException

Description copied from interface: SubTaskManager

Change the parent of the given subtask to the given new parent on behalf of the given user.

Specified by:

changeParent in interface SubTaskManager

Parameters:

subTask - The SubTask

newParentIssue - The parent Issue

currentUser - The user

Returns:

an IssueUpdateBean representing the change action.

Throws:

RemoveException - if there's a problem unlinking original parent.

CreateException - if there's a problem linking new parent.