com.atlassian.jira.config
Interface SubTaskManager

All Known Implementing Classes:
DefaultSubTaskManager, MockSubTaskManager

@PublicApi
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, com.atlassian.crowd.embedded.api.User currentUser)
          Deprecated. Use changeParent(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User) instead. Since v5.0.
 IssueUpdateBean changeParent(Issue subTask, Issue parentIssue, com.atlassian.crowd.embedded.api.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, com.atlassian.crowd.embedded.api.User remoteUser)
          Deprecated. Use createSubTaskIssueLink(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User) instead. Since v5.0.
 void createSubTaskIssueLink(Issue parentIssue, Issue subTaskIssue, com.atlassian.crowd.embedded.api.User remoteUser)
           
 org.ofbiz.core.entity.GenericValue createSubTaskIssueType(String name, Long sequence, String description, String iconurl)
          Deprecated. Use insertSubTaskIssueType(String, Long, String, String) instead. Since v5.0.
 void disableSubTasks()
           
 void enableSubTasks()
           
 Collection<Long> getAllSubTaskIssueIds()
           
 org.ofbiz.core.entity.GenericValue getParentIssue(org.ofbiz.core.entity.GenericValue issue)
          Deprecated. Use Issue.getParentObject() instead. Since v5.0.
 Long getParentIssueId(org.ofbiz.core.entity.GenericValue issue)
           
 SubTaskBean getSubTaskBean(org.ofbiz.core.entity.GenericValue issue, com.atlassian.crowd.embedded.api.User remoteUser)
          Deprecated. Use getSubTaskBean(com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User) instead. Since v5.0.
 SubTaskBean getSubTaskBean(Issue issue, com.atlassian.crowd.embedded.api.User 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.
 org.ofbiz.core.entity.GenericValue getSubTaskIssueTypeById(String id)
          Deprecated. Use getSubTaskIssueType(String) instead. Since v5.0.
 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.
 IssueType insertSubTaskIssueType(String name, Long sequence, String description, Long avatarId)
          Create new issue type and adds it to default scheme.
 IssueType insertSubTaskIssueType(String name, Long sequence, String description, String iconurl)
          Deprecated. Use insertSubTaskIssueType(String, Long, String, Long) since v6.3.
 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)
          Deprecated. Use moveSubTask(com.atlassian.jira.issue.Issue, Long, Long) instead. Since v5.0.
 void moveSubTask(Issue issue, 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.
 void updateSubTaskIssueType(String id, String name, Long sequence, String description, String iconurl)
          Deprecated. Use updateSubTaskIssueType(String, String, Long, String, Long) instead. Since v6.3.
 

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)
Deprecated. Use Issue.getParentObject() instead. Since v5.0.

Get the parent issue from a subtask

Parameters:
issue - subtask
Returns:
the parent issue form a subtask

getSubTaskBean

SubTaskBean getSubTaskBean(org.ofbiz.core.entity.GenericValue issue,
                           com.atlassian.crowd.embedded.api.User remoteUser)
Deprecated. Use getSubTaskBean(com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User) instead. Since v5.0.

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

Parameters:
issue - the Issue
remoteUser - the user
Returns:
the SubTaskBean for the given parent issue in the context of the given user.

getSubTaskBean

SubTaskBean getSubTaskBean(Issue issue,
                           com.atlassian.crowd.embedded.api.User remoteUser)
Returns the SubTaskBean for the given parent issue in the context of the given user.

Parameters:
issue - the Issue
remoteUser - the user
Returns:
the SubTaskBean for the given parent issue in the context of the given user.

moveSubTask

void moveSubTask(org.ofbiz.core.entity.GenericValue issue,
                 Long currentSequence,
                 Long sequence)
Deprecated. Use moveSubTask(com.atlassian.jira.issue.Issue, Long, Long) instead. Since v5.0.

move SubTask

Parameters:
issue -
currentSequence -
sequence -

moveSubTask

void moveSubTask(Issue issue,
                 Long currentSequence,
                 Long sequence)

resetSequences

void resetSequences(Issue issue)

createSubTaskIssueType

org.ofbiz.core.entity.GenericValue createSubTaskIssueType(String name,
                                                          Long sequence,
                                                          String description,
                                                          String iconurl)
                                                          throws CreateException
Deprecated. Use insertSubTaskIssueType(String, Long, String, String) instead. Since v5.0.

create SubTask IssueType

Parameters:
name -
sequence -
description -
iconurl -
Returns:
Throws:
CreateException

insertSubTaskIssueType

@Deprecated
IssueType insertSubTaskIssueType(String name,
                                            Long sequence,
                                            String description,
                                            String iconurl)
                                 throws CreateException
Deprecated. Use insertSubTaskIssueType(String, Long, String, Long) since v6.3.

Create new issue type and adds it to default scheme.

Throws:
CreateException

insertSubTaskIssueType

IssueType insertSubTaskIssueType(String name,
                                 Long sequence,
                                 String description,
                                 Long avatarId)
                                 throws CreateException
Create new issue type and adds it to default scheme.

Throws:
CreateException
Since:
v6.3

updateSubTaskIssueType

@Deprecated
void updateSubTaskIssueType(String id,
                                       String name,
                                       Long sequence,
                                       String description,
                                       String iconurl)
                            throws DataAccessException
Deprecated. Use updateSubTaskIssueType(String, String, Long, String, Long) instead. Since v6.3.

Throws:
DataAccessException

updateSubTaskIssueType

void updateSubTaskIssueType(String id,
                            String name,
                            Long sequence,
                            String description,
                            Long avatarId)
                            throws DataAccessException
Update existing sub-task issue type.

Throws:
DataAccessException
Since:
v6.3

removeSubTaskIssueType

void removeSubTaskIssueType(String name)
                            throws RemoveException
Throws:
RemoveException

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)
Deprecated. Use getSubTaskIssueType(String) instead. Since v5.0.

Returns the SubTask IssueType with the given ID.

Parameters:
id - the ID
Returns:
SubTask IssueType with the given ID.

getSubTaskIssueType

IssueType getSubTaskIssueType(String id)
Returns the SubTask IssueType with the given ID.

Parameters:
id - the ID
Returns:
SubTask IssueType with the given ID.

createSubTaskIssueLink

void createSubTaskIssueLink(org.ofbiz.core.entity.GenericValue parentIssue,
                            org.ofbiz.core.entity.GenericValue subTaskIssue,
                            com.atlassian.crowd.embedded.api.User remoteUser)
                            throws CreateException
Deprecated. Use createSubTaskIssueLink(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User) instead. Since v5.0.

create SubTask IssueLink

Parameters:
parentIssue -
subTaskIssue -
remoteUser -
Throws:
CreateException

createSubTaskIssueLink

void createSubTaskIssueLink(Issue parentIssue,
                            Issue subTaskIssue,
                            com.atlassian.crowd.embedded.api.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,
                             com.atlassian.crowd.embedded.api.User currentUser)
                             throws RemoveException,
                                    CreateException
Deprecated. Use changeParent(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User) instead. Since v5.0.

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.

changeParent

IssueUpdateBean changeParent(Issue subTask,
                             Issue parentIssue,
                             com.atlassian.crowd.embedded.api.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.


Copyright © 2002-2014 Atlassian. All Rights Reserved.