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)
          Persists a new 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)
          Deprecated. Use getEntitiesByIssueObject(String, Issue) instead.
 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)
          Deprecated. Use getIssueObject(Long) instead.
 org.ofbiz.core.entity.GenericValue getIssue(String key)
          Deprecated. Use getIssueObject(String) instead.
 org.ofbiz.core.entity.GenericValue getIssueByWorkflow(Long wfid)
          Retrieves an issue GenericValue given a workflow ID.
 long getIssueCountForProject(Long projectId)
          Returns the number of issues that exist for the provided project id.
 Collection getIssueIdsForProject(Long projectId)
          Returns all issue ids for a particular project.
 MutableIssue getIssueObject(Long id)
          Retrieves an issue by id.
 MutableIssue getIssueObject(String key)
          Retrieves the Issue that has the given key, or null if no such Issue exists.
 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)
          Deprecated. Use getIssueWatchers(Issue) instead
 List getIssueWatchers(Issue issue)
          Return a list of watchers for a particular issue.
 List getProjectIssues(org.ofbiz.core.entity.GenericValue project)
          Deprecated. only used in test cases, should use a search provider instead.
 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 true if the issue can be edited.
 

Method Detail

getIssue

org.ofbiz.core.entity.GenericValue getIssue(Long id)
                                            throws DataAccessException
Deprecated. Use getIssueObject(Long) instead.

Retrieves an issue by its id.

Parameters:
id - Issue ID.
Returns:
An issue GenericValue.
Throws:
DataAccessException - if there is an error in the Data Access Layer.

getIssue

org.ofbiz.core.entity.GenericValue getIssue(String key)
                                            throws org.ofbiz.core.entity.GenericEntityException
Deprecated. Use getIssueObject(String) instead.

Retrieves the issue as a GenericValue with the given key.

Parameters:
key - the issue key.
Returns:
the issue as a GenericValue.
Throws:
org.ofbiz.core.entity.GenericEntityException - if there is a problem getting the data

getIssueByWorkflow

org.ofbiz.core.entity.GenericValue getIssueByWorkflow(Long wfid)
                                                      throws org.ofbiz.core.entity.GenericEntityException
Retrieves an issue GenericValue given a workflow ID. This is used when transitioning through the various steps of a workflow.

Parameters:
wfid - workflow ID.
Returns:
An issue GenericValue.
Throws:
org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

getIssueObject

MutableIssue getIssueObject(Long id)
                            throws DataAccessException
Retrieves an issue by id. This method will always return a new instance of an issue.

Parameters:
id - the id
Returns:
A MutableIssue
Throws:
DataAccessException - if there is an error in the Data Access Layer.

getIssueObject

MutableIssue getIssueObject(String key)
                            throws DataAccessException
Retrieves the Issue that has the given key, or null if no such Issue exists.

This method will always return a new instance of an issue object if the issue exists.

Parameters:
key - The Issue key.
Returns:
a MutableIssue with the given key, or null if no such Issue exists.
Throws:
DataAccessException - if there is an error in the Data Access Layer.

getIssues

List getIssues(Collection ids)
Get issues with the following ids. The issues are sorted in the order that the ids were given in.

Parameters:
ids - Issue IDs.
Returns:
A collection of issue GenericValues

getVotedIssues

List getVotedIssues(User user)
                    throws org.ofbiz.core.entity.GenericEntityException,
                           EntityNotFoundException
Get a list of issues that the user has voted on.

Parameters:
user - The user.
Returns:
A list of Issue objects
Throws:
EntityNotFoundException - Looks like this is not actually thrown TODO: EntityNotFoundException does not seem to be needed.
org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

getIssueWatchers

List getIssueWatchers(org.ofbiz.core.entity.GenericValue issue)
                      throws org.ofbiz.core.entity.GenericEntityException,
                             EntityNotFoundException
Deprecated. Use getIssueWatchers(Issue) instead

Return a list of watchers for a particular issue.

Parameters:
issue - the Issue.
Returns:
A list of Users.
Throws:
org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.
EntityNotFoundException - Thrown when User/Group is looked up by name that does not exist.

getIssueWatchers

List getIssueWatchers(Issue issue)
                      throws org.ofbiz.core.entity.GenericEntityException,
                             EntityNotFoundException
Return a list of watchers for a particular issue.

Parameters:
issue - the Issue
Returns:
A list of Users.
Throws:
org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.
EntityNotFoundException - Thrown when User/Group is looked up by name that does not exist.

getWatchedIssues

List getWatchedIssues(User user)
                      throws org.ofbiz.core.entity.GenericEntityException,
                             EntityNotFoundException
Get a list of issues that the user is watching

Parameters:
user - the User.
Returns:
A list of Issue objects
Throws:
EntityNotFoundException - Thrown when User/Group is looked up by name that does not exist.
org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

execute

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, or null if the searchrequest supplied was null.
Throws:
SearchException

getEntitiesByIssue

List getEntitiesByIssue(String relationName,
                        org.ofbiz.core.entity.GenericValue issue)
                        throws org.ofbiz.core.entity.GenericEntityException
Deprecated. Use getEntitiesByIssueObject(String, Issue) instead.

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 - An exception in the ofbiz Entity Engine.

getEntitiesByIssueObject

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 - An exception in the ofbiz Entity Engine.

getIssuesByEntity

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 - An exception in the ofbiz Entity Engine.

createIssue

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

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

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

Parameters:
remoteUser - Issue creator
issue - The new issue.
Returns:
GenericValue representing the new issue.
Throws:
CreateException

getProjectIssues

List getProjectIssues(org.ofbiz.core.entity.GenericValue project)
                      throws org.ofbiz.core.entity.GenericEntityException
Deprecated. only used in test cases, should use a search provider instead.

Get all the issues for a given project.

Parameters:
project - the Project
Returns:
a List of GenericValue objects
Throws:
org.ofbiz.core.entity.GenericEntityException

isEditable

boolean isEditable(Issue issue)
Returns true if the issue can be edited. This is determined by looking at the workflow step the issue is in.

Parameters:
issue - the Issue.
Returns:
true if the issue can be edited. This is determined by looking at the workflow step the issue is in.

getIssueIdsForProject

Collection getIssueIdsForProject(Long projectId)
                                 throws org.ofbiz.core.entity.GenericEntityException
Returns all issue ids for a particular project. This uses constant memory (i.e. doesn't load all issues into memory.

Parameters:
projectId - Project ID.
Returns:
A collection of issue ID strings
Throws:
org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

getIssueCountForProject

long getIssueCountForProject(Long projectId)
Returns the number of issues that exist for the provided project id.

Parameters:
projectId - identifies the project which the issues are associated with
Returns:
a count of how many issues exist in the project


Copyright © 2002-2008 Atlassian. All Rights Reserved.