com.atlassian.jira.config
Interface SubTaskManager

All Known Implementing Classes:

DefaultSubTaskManager

public interface SubTaskManager

Manages SubTasks - issues that are "part of" other issues.

Field Summary

static String	SUB_TASK_ISSUE_TYPE_STYLE
static String	SUB_TASK_LINK_TYPE_INWARD_NAME
static String	SUB_TASK_LINK_TYPE_NAME
static String	SUB_TASK_LINK_TYPE_OUTWARD_NAME
static String	SUB_TASK_LINK_TYPE_STYLE

Method Summary

IssueUpdateBean	changeParent(org.ofbiz.core.entity.GenericValue subTask, org.ofbiz.core.entity.GenericValue parentIssue, User currentUser) Change the parent of the given subtask to the given new parent on behalf of the given user.
void	createSubTaskIssueLink(org.ofbiz.core.entity.GenericValue parentIssue, org.ofbiz.core.entity.GenericValue subTaskIssue, User remoteUser)
void	createSubTaskIssueLink(Issue parentIssue, Issue subTaskIssue, User remoteUser)
org.ofbiz.core.entity.GenericValue	createSubTaskIssueType(String name, Long sequence, String description, String iconurl)
void	disableSubTasks()
void	enableSubTasks()
Collection<Long>	getAllSubTaskIssueIds()
org.ofbiz.core.entity.GenericValue	getParentIssue(org.ofbiz.core.entity.GenericValue issue)
Long	getParentIssueId(org.ofbiz.core.entity.GenericValue issue)
SubTaskBean	getSubTaskBean(org.ofbiz.core.entity.GenericValue issue, User remoteUser)
List<IssueLink>	getSubTaskIssueLinks(Long issueId) Returns a list of issue links associated with the issue
org.ofbiz.core.entity.GenericValue	getSubTaskIssueTypeById(String id)
Collection<IssueType>	getSubTaskIssueTypeObjects() Retrieves all the sub-task issue types
Collection<Issue>	getSubTaskObjects(Issue issue)
Collection<org.ofbiz.core.entity.GenericValue>	getSubTasks(org.ofbiz.core.entity.GenericValue issue) Deprecated. Use getSubTaskObjects(com.atlassian.jira.issue.Issue) instead.
Collection<org.ofbiz.core.entity.GenericValue>	getSubTasksIssueTypes() Deprecated. Use getSubTaskIssueTypeObjects() instead. Deprecated since v4.1
boolean	isSubTask(org.ofbiz.core.entity.GenericValue issue)
boolean	isSubTaskIssueType(org.ofbiz.core.entity.GenericValue issueType)
boolean	isSubTasksEnabled()
boolean	issueTypeExistsById(String id)
boolean	issueTypeExistsByName(String name)
void	moveSubTask(org.ofbiz.core.entity.GenericValue issue, Long currentSequence, Long sequence)
void	moveSubTaskIssueTypeDown(String id)
void	moveSubTaskIssueTypeUp(String id)
void	removeSubTaskIssueType(String name)
void	resetSequences(org.ofbiz.core.entity.GenericValue issue) Deprecated. since 3.9 use resetSequences(com.atlassian.jira.issue.Issue)
void	resetSequences(Issue issue)
void	updateSubTaskIssueType(String id, String name, Long sequence, String description, String iconurl)

Field Detail

SUB_TASK_ISSUE_TYPE_STYLE

static final String SUB_TASK_ISSUE_TYPE_STYLE

See Also:

Constant Field Values

SUB_TASK_LINK_TYPE_NAME

static final String SUB_TASK_LINK_TYPE_NAME

See Also:

Constant Field Values

SUB_TASK_LINK_TYPE_STYLE

static final String SUB_TASK_LINK_TYPE_STYLE

See Also:

Constant Field Values

SUB_TASK_LINK_TYPE_INWARD_NAME

static final String SUB_TASK_LINK_TYPE_INWARD_NAME

See Also:

Constant Field Values

SUB_TASK_LINK_TYPE_OUTWARD_NAME

static final String SUB_TASK_LINK_TYPE_OUTWARD_NAME

See Also:

Constant Field Values

Method Detail

enableSubTasks

void enableSubTasks()
                    throws CreateException

Throws:

CreateException

isSubTasksEnabled

boolean isSubTasksEnabled()

disableSubTasks

void disableSubTasks()

isSubTask

boolean isSubTask(org.ofbiz.core.entity.GenericValue issue)

isSubTaskIssueType

boolean isSubTaskIssueType(org.ofbiz.core.entity.GenericValue issueType)

getParentIssueId

Long getParentIssueId(org.ofbiz.core.entity.GenericValue issue)

getParentIssue

org.ofbiz.core.entity.GenericValue getParentIssue(org.ofbiz.core.entity.GenericValue issue)

getSubTaskBean

SubTaskBean getSubTaskBean(org.ofbiz.core.entity.GenericValue issue,
                           User remoteUser)

moveSubTask

void moveSubTask(org.ofbiz.core.entity.GenericValue issue,
                 Long currentSequence,
                 Long sequence)

resetSequences

void resetSequences(org.ofbiz.core.entity.GenericValue issue)

Deprecated. since 3.9 use resetSequences(com.atlassian.jira.issue.Issue)

Parameters:

issue - The Issue

resetSequences

void resetSequences(Issue issue)

createSubTaskIssueType

org.ofbiz.core.entity.GenericValue createSubTaskIssueType(String name,
                                                          Long sequence,
                                                          String description,
                                                          String iconurl)
                                                          throws CreateException

Throws:

CreateException

updateSubTaskIssueType

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

Throws:

DataAccessException

removeSubTaskIssueType

void removeSubTaskIssueType(String name)
                            throws RemoveException

Throws:

RemoveException

getSubTasksIssueTypes

@Deprecated
Collection<org.ofbiz.core.entity.GenericValue> getSubTasksIssueTypes()

Deprecated. Use getSubTaskIssueTypeObjects() instead. Deprecated since v4.1

Retrieves all the sub-task issue types.

Returns:

A Collection of sub-task GenericValues.

getSubTaskIssueTypeObjects

Collection<IssueType> getSubTaskIssueTypeObjects()

Retrieves all the sub-task issue types

Returns:

A Collection of all sub-task IssueTypes.

Since:

4.1

issueTypeExistsById

boolean issueTypeExistsById(String id)

issueTypeExistsByName

boolean issueTypeExistsByName(String name)

moveSubTaskIssueTypeUp

void moveSubTaskIssueTypeUp(String id)
                            throws DataAccessException

Throws:

DataAccessException

moveSubTaskIssueTypeDown

void moveSubTaskIssueTypeDown(String id)
                              throws DataAccessException

Throws:

DataAccessException

getSubTaskIssueTypeById

org.ofbiz.core.entity.GenericValue getSubTaskIssueTypeById(String id)

createSubTaskIssueLink

void createSubTaskIssueLink(org.ofbiz.core.entity.GenericValue parentIssue,
                            org.ofbiz.core.entity.GenericValue subTaskIssue,
                            User remoteUser)
                            throws CreateException

Throws:

CreateException

createSubTaskIssueLink

void createSubTaskIssueLink(Issue parentIssue,
                            Issue subTaskIssue,
                            User remoteUser)
                            throws CreateException

Throws:

CreateException

getAllSubTaskIssueIds

Collection<Long> getAllSubTaskIssueIds()

getSubTaskIssueLinks

List<IssueLink> getSubTaskIssueLinks(Long issueId)

Returns a list of issue links associated with the issue

Parameters:

issueId - issue id

Returns:

a list of issue links

getSubTasks

Collection<org.ofbiz.core.entity.GenericValue> getSubTasks(org.ofbiz.core.entity.GenericValue issue)

Deprecated. Use getSubTaskObjects(com.atlassian.jira.issue.Issue) instead.

Parameters:

issue - the issue

Returns:

subtasks as GenericValues

getSubTaskObjects

Collection<Issue> getSubTaskObjects(Issue issue)

changeParent

IssueUpdateBean changeParent(org.ofbiz.core.entity.GenericValue subTask,
                             org.ofbiz.core.entity.GenericValue parentIssue,
                             User currentUser)
                             throws RemoveException,
                                    CreateException

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

Parameters:

subTask - The SubTask

parentIssue - 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.