com.atlassian.jira.issue
Interface IssueManager

All Superinterfaces:

JiraManager

All Known Implementing Classes:

CachingIssueManager, DefaultIssueManager

public interface IssueManager

extends JiraManager

A class to manage interactions with issues

Method Summary

org.ofbiz.core.entity.GenericValue	createIssue(String remoteUserName, Map fields) Creates an issue.
org.ofbiz.core.entity.GenericValue	createIssue(User remoteUser, Issue issue)
org.ofbiz.core.entity.GenericValue	createIssue(User remoteUser, Map fields) Creates an issue.
List	execute(SearchRequest searchRequest, User searcher) Deprecated. Please use SearchProvider.search(SearchRequest, com.opensymphony.user.User, com.atlassian.jira.web.bean.PagerFilter) instead, which returns Issues.
List	getEntitiesByIssue(String relationName, org.ofbiz.core.entity.GenericValue issue) Get a list of entities (versions, components etc) related to this issue.
List	getEntitiesByIssueObject(String relationName, Issue issue) Get a list of entities (versions, components etc) related to this issue.
org.ofbiz.core.entity.GenericValue	getIssue(Long id)
org.ofbiz.core.entity.GenericValue	getIssue(String key)
org.ofbiz.core.entity.GenericValue	getIssueByWorkflow(Long wfid)
MutableIssue	getIssueObject(Long id)
MutableIssue	getIssueObject(String key)
List	getIssues(Collection ids) Get issues with the following ids.
List	getIssuesByEntity(String relationName, org.ofbiz.core.entity.GenericValue entity) Get a list of issues related to an entity (version, component etc).
List	getIssueWatchers(org.ofbiz.core.entity.GenericValue issue)
List	getIssueWatchers(Issue issue)
List	getProjectIssues(org.ofbiz.core.entity.GenericValue project) Get all the issues for a given project.
List	getVotedIssues(User user) Get a list of issues that the user has voted on
List	getWatchedIssues(User user) Get a list of issues that the user is watching
boolean	isEditable(Issue issue) Returns whether the issue can be edited.

Method Detail

getIssue

public org.ofbiz.core.entity.GenericValue getIssue(Long id)
                                            throws DataAccessException

Throws:

DataAccessException

getIssue

public org.ofbiz.core.entity.GenericValue getIssue(String key)
                                            throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getIssueByWorkflow

public org.ofbiz.core.entity.GenericValue getIssueByWorkflow(Long wfid)
                                                      throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getIssueObject

public MutableIssue getIssueObject(Long id)
                            throws DataAccessException

Throws:

DataAccessException

getIssueObject

public MutableIssue getIssueObject(String key)
                            throws DataAccessException

Throws:

DataAccessException

getIssues

public List getIssues(Collection ids)

Get issues with the following ids. The issues are sorted in the order that the ids were given in.

getVotedIssues

public List getVotedIssues(User user)
                    throws org.ofbiz.core.entity.GenericEntityException,
                           EntityNotFoundException

Get a list of issues that the user has voted on

Returns:

A list of Issue objects

Throws:

org.ofbiz.core.entity.GenericEntityException

EntityNotFoundException

getIssueWatchers

public List getIssueWatchers(org.ofbiz.core.entity.GenericValue issue)
                      throws org.ofbiz.core.entity.GenericEntityException,
                             EntityNotFoundException

Throws:

org.ofbiz.core.entity.GenericEntityException

EntityNotFoundException

getIssueWatchers

public List getIssueWatchers(Issue issue)
                      throws org.ofbiz.core.entity.GenericEntityException,
                             EntityNotFoundException

Throws:

org.ofbiz.core.entity.GenericEntityException

EntityNotFoundException

getWatchedIssues

public List getWatchedIssues(User user)
                      throws org.ofbiz.core.entity.GenericEntityException,
                             EntityNotFoundException

Get a list of issues that the user is watching

Returns:

A list of Issue objects

Throws:

org.ofbiz.core.entity.GenericEntityException

EntityNotFoundException

execute

public List execute(SearchRequest searchRequest,
                    User searcher)
             throws SearchException

Deprecated. Please use SearchProvider.search(SearchRequest, com.opensymphony.user.User, com.atlassian.jira.web.bean.PagerFilter) instead, which returns Issues.

Takes a search request object and returns a list of issues that match the search request

Parameters:

searchRequest - object to be used to search for

searcher - User who is running the search. Make sure this user has permissions to see the issues you want!

Returns:

A List of Issues that match the search request

Throws:

SearchException

getEntitiesByIssue

public List getEntitiesByIssue(String relationName,
                               org.ofbiz.core.entity.GenericValue issue)
                        throws org.ofbiz.core.entity.GenericEntityException

Get a list of entities (versions, components etc) related to this issue.

Parameters:

relationName - A IssueRelationConstants string indicating some issue relation

issue - Issue to consider

Returns:

A list of entity GenericValues associated with the issue.

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntitiesByIssueObject

public List getEntitiesByIssueObject(String relationName,
                                     Issue issue)
                              throws org.ofbiz.core.entity.GenericEntityException

Get a list of entities (versions, components etc) related to this issue.

Parameters:

relationName - A IssueRelationConstants string indicating some issue relation

issue - Issue to consider

Returns:

A list of entity GenericValues associated with the issue.

Throws:

org.ofbiz.core.entity.GenericEntityException

getIssuesByEntity

public List getIssuesByEntity(String relationName,
                              org.ofbiz.core.entity.GenericValue entity)
                       throws org.ofbiz.core.entity.GenericEntityException

Get a list of issues related to an entity (version, component etc).

Parameters:

relationName - A IssueRelationConstants string indicating some relation of entity

entity - The entity related to the issues we're after

Returns:

A list of issue GenericValues associated with an entity.

Throws:

org.ofbiz.core.entity.GenericEntityException

createIssue

public org.ofbiz.core.entity.GenericValue createIssue(String remoteUserName,
                                                      Map fields)
                                               throws CreateException

Creates an issue.

Parameters:

remoteUserName - Issue creator

fields - A map of the issue's immediate field values. See the Issue definition in entitymodel.xml for values.

Returns:

GenericValue representing the new issue.

Throws:

CreateException

createIssue

public org.ofbiz.core.entity.GenericValue createIssue(User remoteUser,
                                                      Map fields)
                                               throws CreateException

Creates an issue.

Parameters:

remoteUser - Issue creator

fields - A map of the issue's immediate field values. See the Issue definition in entitymodel.xml for values.

Returns:

GenericValue representing the new issue.

Throws:

CreateException

createIssue

public org.ofbiz.core.entity.GenericValue createIssue(User remoteUser,
                                                      Issue issue)
                                               throws CreateException

Throws:

CreateException

getProjectIssues

public List getProjectIssues(org.ofbiz.core.entity.GenericValue project)
                      throws org.ofbiz.core.entity.GenericEntityException

Get all the issues for a given project.

Throws:

org.ofbiz.core.entity.GenericEntityException

isEditable

public boolean isEditable(Issue issue)

Returns whether the issue can be edited. This is determined by looking at the workflow step the issue is in.