com.atlassian.jira.issue.managers

Class RequestCachingIssueManager

java.lang.Object

com.atlassian.jira.issue.managers.RequestCachingIssueManager

All Implemented Interfaces:

IssueManager

public class RequestCachingIssueManager
extends Object
implements IssueManager

Constructor Summary

Constructors

Constructor and Description
RequestCachingIssueManager(IssueManager delegate, FeatureManager featureManager)

Method Summary

Modifier and Type	Method and Description
Issue	archiveIssue(ApplicationUser user, Issue issue, EventDispatchOption eventDispatchOption, boolean sendMail) This method will archive the issue.
boolean	atLeastOneIssueExists() Return true if an issue exists.
org.ofbiz.core.entity.GenericValue	createIssue(ApplicationUser remoteUser, Issue issue) Deprecated.
org.ofbiz.core.entity.GenericValue	createIssue(ApplicationUser remoteUser, Map<String,Object> fields) Deprecated.
org.ofbiz.core.entity.GenericValue	createIssue(String remoteUserName, Map<String,Object> fields) Deprecated.
Issue	createIssueObject(ApplicationUser remoteUser, Issue issue) Creates an issue.
Issue	createIssueObject(ApplicationUser remoteUser, Map<String,Object> fields) Creates an issue.
Issue	createIssueObject(String remoteUserName, Map<String,Object> fields) Creates an issue.
void	deleteIssue(ApplicationUser user, Issue issue, EventDispatchOption eventDispatchOption, boolean sendMail) This method will delete an issue from JIRA.
void	deleteIssue(ApplicationUser user, MutableIssue issue, EventDispatchOption eventDispatchOption, boolean sendMail) Deprecated.
void	deleteIssueNoEvent(Issue issue) Delete issue without firing any events, or sending notifications.
void	deleteIssueNoEvent(MutableIssue issue) Deprecated.
Issue	findMovedIssue(String oldIssueKey) Returns an issue that has been moved by searching on the old issue key.
Set<String>	getAllIssueKeys(Long issueId) Returns all issue keys that are associated with Issue.
List<org.ofbiz.core.entity.GenericValue>	getEntitiesByIssue(String relationName, org.ofbiz.core.entity.GenericValue issue) Get a list of entities (versions, components etc) related to this issue.
List<org.ofbiz.core.entity.GenericValue>	getEntitiesByIssueObject(String relationName, Issue issue) Get a list of entities (versions, components etc) related to this issue.
Set<Long>	getIdsOfMissingIssues(Set<Long> issueIds) Check existence of issues for the given set of IDs
org.ofbiz.core.entity.GenericValue	getIssue(Long id) Deprecated.
org.ofbiz.core.entity.GenericValue	getIssue(String key) Deprecated.
MutableIssue	getIssueByCurrentKey(String key) Retrieves the Issue that has the given key, or null if no such Issue exists.
MutableIssue	getIssueByKeyIgnoreCase(String key) Retrieves the Issue that has the given key, or null if no such Issue exists.
org.ofbiz.core.entity.GenericValue	getIssueByWorkflow(Long wfid) Deprecated.
long	getIssueCount() Returns the number of issues.
long	getIssueCountForProject(Long projectId) Returns the number of issues that exist for the provided project id.
Collection<Long>	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.
MutableIssue	getIssueObjectByWorkflow(Long workflowId) Retrieves an issue given a workflow ID.
List<Issue>	getIssueObjects(Collection<Long> ids) Get issues with the following ids.
List<Issue>	getIssueObjectsByEntity(String relationName, org.ofbiz.core.entity.GenericValue entity) Get a list of issues related to an entity (version, component etc).
List<org.ofbiz.core.entity.GenericValue>	getIssues(Collection<Long> ids) Deprecated.
List<org.ofbiz.core.entity.GenericValue>	getIssuesByEntity(String relationName, org.ofbiz.core.entity.GenericValue entity) Get a list of issues related to an entity (version, component etc).
Set<String>	getKeysOfMissingIssues(Set<String> issueKeys) Check existence of issues for the given set of keys
List<org.ofbiz.core.entity.GenericValue>	getProjectIssues(org.ofbiz.core.entity.GenericValue project) Deprecated.
Set<Pair<Long,String>>	getProjectIssueTypePairsByIds(Set<Long> issueIds) Returns a set of project ID / issue type combinations that given issue IDs cover.
Set<Pair<Long,String>>	getProjectIssueTypePairsByKeys(Set<String> issueKeys) Returns a set of project ID / issue type combinations that given issue keys cover.
long	getUnassignedIssueCount() Returns the number of unassigned issues.
List<Issue>	getVotedIssues(ApplicationUser user) Get a list of issues that the user has voted on and can see.
List<Issue>	getVotedIssuesOverrideSecurity(ApplicationUser user) Get a list of issues that the user has voted on.
List<Issue>	getWatchedIssues(ApplicationUser user) Get a list of issues that the user is watching and can see.
List<Issue>	getWatchedIssuesOverrideSecurity(ApplicationUser user) Get a list of issues that the user is watching
List<ApplicationUser>	getWatchers(Issue issue) Return a list of watchers for a particular issue.
List<ApplicationUser>	getWatchersFor(Issue issue) Return a list of watchers for a particular issue.
boolean	hasUnassignedIssues() Returns a boolean indicating whether there are unassigned issues.
boolean	isEditable(Issue issue) Returns true if the issue can be edited.
boolean	isEditable(Issue issue, ApplicationUser user) Returns true if the issue can be edited by the current user.
boolean	isEditable(Issue issue, String nextStatusId) Returns true if the issue can be edited after action.
boolean	isExistingIssueKey(String issueKey) Returns true if issue with a given key exists (it looks for issues having current issue key set for the value, and moved issue keys that used the key).
void	recordMovedIssueKey(Issue oldIssue) Used internally when we want to record that an Issue has changed its Issue key (because it has moved project).
Issue	restoreIssue(ApplicationUser user, Issue issue, EventDispatchOption eventDispatchOption, boolean sendMail) This method will restore an archived issue.
Issue	updateIssue(ApplicationUser user, MutableIssue issue, EventDispatchOption eventDispatchOption, boolean sendMail) This method will store the provided issue to the JIRA datastore.
Issue	updateIssue(ApplicationUser user, MutableIssue issue, UpdateIssueRequest updateIssueRequest) This method will store the provided issue to the JIRA datastore.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestCachingIssueManager

public RequestCachingIssueManager(IssueManager delegate,
                                  FeatureManager featureManager)

Method Detail

getIssueObject

public MutableIssue getIssueObject(Long id)
                            throws DataAccessException

Description copied from interface: IssueManager

Retrieves an issue by id. This method will always return a new instance of an issue.

Specified by:

getIssueObject in interface IssueManager

Parameters:

id - the id

Returns:

A MutableIssue

Throws:

DataAccessException - if there is an error in the Data Access Layer.

getIssueObject

public MutableIssue getIssueObject(String key)
                            throws DataAccessException

Description copied from interface: IssueManager

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.

Specified by:

getIssueObject in interface IssueManager

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.

getIssueByKeyIgnoreCase

@ExperimentalApi
public MutableIssue getIssueByKeyIgnoreCase(String key)
                                                      throws DataAccessException

Description copied from interface: IssueManager

Retrieves the Issue that has the given key, or null if no such Issue exists.

This method will ignore case of issue key.

Specified by:

getIssueByKeyIgnoreCase in interface IssueManager

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.

getIssueByCurrentKey

@ExperimentalApi
public MutableIssue getIssueByCurrentKey(String key)
                                                   throws DataAccessException

Description copied from interface: IssueManager

Retrieves the Issue that has the given key, or null if no such Issue exists.

This method will strictly only return the issue which has current issue key equal to the one given.

Specified by:

getIssueByCurrentKey in interface IssueManager

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

@Deprecated
public List<org.ofbiz.core.entity.GenericValue> getIssues(Collection<Long> ids)

Deprecated.

Description copied from interface: IssueManager

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

Specified by:

getIssues in interface IssueManager

Parameters:

ids - Issue IDs.

Returns:

A collection of issue GenericValues

getIssueObjects

public List<Issue> getIssueObjects(Collection<Long> ids)

Description copied from interface: IssueManager

Get issues with the following ids. The issues are sorted in the order that the ids were given in. Any ids that are not found will be missing from the list. That is list will not contains nulls.

Specified by:

getIssueObjects in interface IssueManager

Parameters:

ids - Issue IDs.

Returns:

A collection of issue MutableIssues

getVotedIssues

public List<Issue> getVotedIssues(ApplicationUser user)

Description copied from interface: IssueManager

Get a list of issues that the user has voted on and can see.

Specified by:

getVotedIssues in interface IssueManager

Parameters:

user - The user.

Returns:

A list of Issue objects the user has voted on.

getVotedIssuesOverrideSecurity

public List<Issue> getVotedIssuesOverrideSecurity(ApplicationUser user)

Description copied from interface: IssueManager

Get a list of issues that the user has voted on.

Specified by:

getVotedIssuesOverrideSecurity in interface IssueManager

Parameters:

user - The user.

Returns:

A list of Issue objects the user has voted on.

getWatchers

public List<ApplicationUser> getWatchers(Issue issue)

Description copied from interface: IssueManager

Return a list of watchers for a particular issue.

Specified by:

getWatchers in interface IssueManager

Parameters:

issue - the Issue

Returns:

A list of Users.

getWatchersFor

public List<ApplicationUser> getWatchersFor(Issue issue)

Description copied from interface: IssueManager

Return a list of watchers for a particular issue.

Specified by:

getWatchersFor in interface IssueManager

Parameters:

issue - the Issue

Returns:

A list of Users.

getWatchedIssues

public List<Issue> getWatchedIssues(ApplicationUser user)

Description copied from interface: IssueManager

Get a list of issues that the user is watching and can see.

Specified by:

getWatchedIssues in interface IssueManager

Parameters:

user - the User.

Returns:

A list of Issue objects

getWatchedIssuesOverrideSecurity

public List<Issue> getWatchedIssuesOverrideSecurity(ApplicationUser user)

Description copied from interface: IssueManager

Get a list of issues that the user is watching

Specified by:

getWatchedIssuesOverrideSecurity in interface IssueManager

Parameters:

user - the User.

Returns:

A list of Issue objects

getEntitiesByIssue

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

Description copied from interface: IssueManager

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

Specified by:

getEntitiesByIssue in interface IssueManager

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

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

Description copied from interface: IssueManager

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

Specified by:

getEntitiesByIssueObject in interface IssueManager

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

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

Description copied from interface: IssueManager

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

Specified by:

getIssuesByEntity in interface IssueManager

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.

getIssueObjectsByEntity

public List<Issue> getIssueObjectsByEntity(String relationName,
                                           org.ofbiz.core.entity.GenericValue entity)
                                    throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueManager

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

Specified by:

getIssueObjectsByEntity in interface IssueManager

Parameters:

relationName - A IssueRelationConstants string indicating some relation of entity

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

Returns:

A list of MutableIssues associated with an entity.

Throws:

org.ofbiz.core.entity.GenericEntityException - if it failed to get the list of issues.

getAllIssueKeys

public Set<String> getAllIssueKeys(Long issueId)

Description copied from interface: IssueManager

Returns all issue keys that are associated with Issue.

Specified by:

getAllIssueKeys in interface IssueManager

Returns:

all issue keys (including the current one) associated with the issue

See Also:

com.atlassian.jira.issue.changehistory.ChangeHistoryManager#getPreviousIssueKeys(Long)

createIssue

@Deprecated
public org.ofbiz.core.entity.GenericValue createIssue(String remoteUserName,
                                                                  Map<String,Object> fields)
                                                           throws CreateException

Deprecated.

Description copied from interface: IssueManager

Creates an issue.

Specified by:

createIssue in interface IssueManager

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 - If JIRA is unable to create the issue.

createIssueObject

public Issue createIssueObject(String remoteUserName,
                               Map<String,Object> fields)
                        throws CreateException

Description copied from interface: IssueManager

Creates an issue.

Specified by:

createIssueObject in interface IssueManager

Parameters:

remoteUserName - Issue creator

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

Returns:

representing the new issue.

Throws:

CreateException - If JIRA is unable to create the issue.

createIssue

@Deprecated
public org.ofbiz.core.entity.GenericValue createIssue(ApplicationUser remoteUser,
                                                                  Map<String,Object> fields)
                                                           throws CreateException

Deprecated.

Description copied from interface: IssueManager

Creates an issue.

Specified by:

createIssue in interface IssueManager

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 - If JIRA is unable to create the issue.

createIssueObject

public Issue createIssueObject(ApplicationUser remoteUser,
                               Map<String,Object> fields)
                        throws CreateException

Description copied from interface: IssueManager

Creates an issue.

Specified by:

createIssueObject in interface IssueManager

Parameters:

remoteUser - Issue creator

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

Returns:

the new issue.

Throws:

CreateException - If JIRA is unable to create the issue.

createIssue

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

Deprecated.

Description copied from interface: IssueManager

Persists a new issue.

Specified by:

createIssue in interface IssueManager

Parameters:

remoteUser - Issue creator

issue - The new issue.

Returns:

GenericValue representing the new issue.

Throws:

CreateException - If JIRA is unable to create the issue.

createIssueObject

public Issue createIssueObject(ApplicationUser remoteUser,
                               Issue issue)
                        throws CreateException

Description copied from interface: IssueManager

Creates an issue.

Specified by:

createIssueObject in interface IssueManager

Parameters:

remoteUser - Issue creator

issue - The new issue.

Returns:

the new issue.

Throws:

CreateException - If JIRA is unable to create the issue.

updateIssue

public Issue updateIssue(ApplicationUser user,
                         MutableIssue issue,
                         EventDispatchOption eventDispatchOption,
                         boolean sendMail)

Description copied from interface: IssueManager

This method will store the provided issue to the JIRA datastore.

The issue will be saved and re-indexed unless EventDispatchOption.DO_NOT_DISPATCH is specified. This method performs no permission checks.

This method should be used if you want to exert more control over what happens when JIRA updates an issue. This method will allow you to specify if an event is dispatched and if so which event is dispatched, see EventDispatchOption. This method also allows you to specify if email notifications should be send to notify users of the update.

Specified by:

updateIssue in interface IssueManager

Parameters:

user - who is performing the operation

issue - the issue to update

eventDispatchOption - specifies if an event should be sent and if so which should be sent.

sendMail - if true mail notifications will be sent, otherwise mail notifications will be suppressed.

Returns:

the updated issue.

updateIssue

public Issue updateIssue(ApplicationUser user,
                         MutableIssue issue,
                         UpdateIssueRequest updateIssueRequest)

Description copied from interface: IssueManager

This method will store the provided issue to the JIRA datastore. The issue will be saved and re-indexed. This method performs no permission checks.

This method should be used if you want to exert more control over what happens when JIRA updates an issue.

Specified by:

updateIssue in interface IssueManager

Parameters:

user - who is performing the operation

issue - the issue to update

updateIssueRequest - details about how to perform the update, including user context, event dispatch strategy and history metadata

Returns:

the updated issue.

See Also:

UpdateIssueRequest

archiveIssue

public Issue archiveIssue(ApplicationUser user,
                          Issue issue,
                          EventDispatchOption eventDispatchOption,
                          boolean sendMail)
                   throws ArchiveException

Description copied from interface: IssueManager

This method will archive the issue.

The issue will be marked as archived and removed from current index. This method performs archiving licence check and permission checks.

This method also allows you to specify if email notifications should be send to notify users of the update.

Specified by:

archiveIssue in interface IssueManager

Parameters:

user - who is performing the operation

issue - the issue to update

eventDispatchOption - specifies if an event should be sent and if so which should be sent.

sendMail - if true mail notifications will be sent, otherwise mail notifications will be suppressed.

Returns:

the archived issue.

Throws:

ArchiveException

restoreIssue

public Issue restoreIssue(ApplicationUser user,
                          Issue issue,
                          EventDispatchOption eventDispatchOption,
                          boolean sendMail)
                   throws ArchiveException

Description copied from interface: IssueManager

This method will restore an archived issue.

The issue will be moved back to index. This method performs archiving licence check and permission checks.

This method also allows you to specify if email notifications should be send to notify users of the update.

Specified by:

restoreIssue in interface IssueManager

Parameters:

user - who is performing the operation

issue - the issue to update

eventDispatchOption - specifies if an event should be sent and if so which should be sent.

sendMail - if true mail notifications will be sent, otherwise mail notifications will be suppressed.

Returns:

the archived issue.

Throws:

ArchiveException

deleteIssue

public void deleteIssue(ApplicationUser user,
                        Issue issue,
                        EventDispatchOption eventDispatchOption,
                        boolean sendMail)
                 throws RemoveException

Description copied from interface: IssueManager

This method will delete an issue from JIRA.

This will clean up all issue associations in JIRA and will de-index the issue.

This method should be used if you want to exert more control over what happens when JIRA deletes an issue. This method will allow you to specify if an event is dispatched and if so which event is dispatched, see EventDispatchOption. This method also allows you to specify if email notifications should be send to notify users of the deletion.

Specified by:

deleteIssue in interface IssueManager

Parameters:

user - who is performing the operation

issue - the issue to delete.

eventDispatchOption - specifies if an event should be sent and if so which should be sent.

sendMail - if true mail notifications will be sent, otherwise mail notifications will be suppressed.

Throws:

RemoveException - throw if something goes horribly wrong when deleting the issue.

deleteIssue

@Deprecated
public void deleteIssue(ApplicationUser user,
                                    MutableIssue issue,
                                    EventDispatchOption eventDispatchOption,
                                    boolean sendMail)
                             throws RemoveException

Deprecated.

Description copied from interface: IssueManager

This method will delete an issue from JIRA. This will clean up all issue associations in JIRA and will de-index the issue.

This method should be used if you want to exert more control over what happens when JIRA deletes an issue. This method will allow you to specify if an event is dispatched and if so which event is dispatched, see EventDispatchOption. This method also allows you to specify if email notifications should be send to notify users of the deletion.

Specified by:

deleteIssue in interface IssueManager

Parameters:

user - who is performing the operation

issue - the issue to delete.

eventDispatchOption - specifies if an event should be sent and if so which should be sent.

sendMail - if true mail notifications will be sent, otherwise mail notifications will be suppressed.

Throws:

RemoveException - throw if something goes horribly wrong when deleting the issue.

deleteIssueNoEvent

public void deleteIssueNoEvent(Issue issue)
                        throws RemoveException

Description copied from interface: IssueManager

Delete issue without firing any events, or sending notifications.

This is preferred in some bulk operations, but normally you would call #deleteIssue(com.atlassian.crowd.embedded.api.User, Issue, com.atlassian.jira.event.type.EventDispatchOption, boolean)

Specified by:

deleteIssueNoEvent in interface IssueManager

Parameters:

issue - issue to delete

Throws:

RemoveException - if the removal fails

See Also:

#deleteIssue(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.Issue, com.atlassian.jira.event.type.EventDispatchOption, boolean)

deleteIssueNoEvent

@Deprecated
public void deleteIssueNoEvent(MutableIssue issue)
                                    throws RemoveException

Deprecated.

Description copied from interface: IssueManager

Delete issue without firing any events, or sending notifications.

This is preferred in some bulk operations, but normally you would call #deleteIssue(com.atlassian.crowd.embedded.api.User, MutableIssue, com.atlassian.jira.event.type.EventDispatchOption, boolean)

Specified by:

deleteIssueNoEvent in interface IssueManager

Parameters:

issue - issue to delete

Throws:

RemoveException - if the removal fails

See Also:

#deleteIssue(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.MutableIssue, com.atlassian.jira.event.type.EventDispatchOption, boolean)

getProjectIssues

@Deprecated
public List<org.ofbiz.core.entity.GenericValue> getProjectIssues(org.ofbiz.core.entity.GenericValue project)
                                                                      throws org.ofbiz.core.entity.GenericEntityException

Deprecated.

Description copied from interface: IssueManager

Get all the issues for a given project.

Specified by:

getProjectIssues in interface IssueManager

Parameters:

project - the Project

Returns:

a List of GenericValue objects

Throws:

org.ofbiz.core.entity.GenericEntityException - If there are errors in the persistence layer.

isEditable

public boolean isEditable(Issue issue)

Description copied from interface: IssueManager

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

Specified by:

isEditable in interface IssueManager

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.

isEditable

public boolean isEditable(@Nonnull
                          Issue issue,
                          @Nonnull
                          String nextStatusId)

Description copied from interface: IssueManager

Returns true if the issue can be edited after action. This is determined by looking at the workflow step the issue will be when action is completed.

Specified by:

isEditable in interface IssueManager

Parameters:

issue - the Issue.

nextStatusId - the id of the status the issue will be in after transition looking at the workflow status the issue will be in, after the action is completed.

isEditable

public boolean isEditable(Issue issue,
                          ApplicationUser user)

Description copied from interface: IssueManager

Returns true if the issue can be edited by the current user. This is determined by looking at both the user's permissions and the workflow step the issue is in.

Specified by:

isEditable in interface IssueManager

Parameters:

issue - the issue you want to edit

user - the user who will be performing the edit

Returns:

true if the user has permission and the issue is in an editable workflow step

getIssueIdsForProject

public Collection<Long> getIssueIdsForProject(Long projectId)
                                       throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueManager

Returns all issue ids for a particular project. This uses constant memory (i.e. doesn't load all issues into memory.

Specified by:

getIssueIdsForProject in interface IssueManager

Parameters:

projectId - Project ID.

Returns:

A collection of issue IDs

Throws:

org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

getIssueCountForProject

public long getIssueCountForProject(Long projectId)

Description copied from interface: IssueManager

Returns the number of issues that exist for the provided project id.

Specified by:

getIssueCountForProject in interface IssueManager

Parameters:

projectId - identifies the project which the issues are associated with

Returns:

a count of how many issues exist in the project

hasUnassignedIssues

public boolean hasUnassignedIssues()

Description copied from interface: IssueManager

Returns a boolean indicating whether there are unassigned issues.

Specified by:

hasUnassignedIssues in interface IssueManager

Returns:

a boolean indicating whether there are unassigned issues

getUnassignedIssueCount

public long getUnassignedIssueCount()

Description copied from interface: IssueManager

Returns the number of unassigned issues.

Specified by:

getUnassignedIssueCount in interface IssueManager

Returns:

the number of unassigned issues

getIssueCount

public long getIssueCount()

Description copied from interface: IssueManager

Returns the number of issues.

Specified by:

getIssueCount in interface IssueManager

Returns:

the number of issues

atLeastOneIssueExists

public boolean atLeastOneIssueExists()

Description copied from interface: IssueManager

Return true if an issue exists. This is a performance enhancement over counting the issues.

Specified by:

atLeastOneIssueExists in interface IssueManager

Returns:

true if an issue exists

findMovedIssue

@Internal
public Issue findMovedIssue(String oldIssueKey)

Description copied from interface: IssueManager

Returns an issue that has been moved by searching on the old issue key.

Specified by:

findMovedIssue in interface IssueManager

Parameters:

oldIssueKey - the original key of an issue that has since been moved (moving between projects assigns a new key to an issue)

Returns:

the moved Issue object

recordMovedIssueKey

@Internal
public void recordMovedIssueKey(Issue oldIssue)

Description copied from interface: IssueManager

Used internally when we want to record that an Issue has changed its Issue key (because it has moved project).

Specified by:

recordMovedIssueKey in interface IssueManager

Parameters:

oldIssue - The issue with it's old issue key

getProjectIssueTypePairsByKeys

@Internal
 @Nonnull
public Set<Pair<Long,String>> getProjectIssueTypePairsByKeys(@Nonnull
                                                                                 Set<String> issueKeys)

Description copied from interface: IssueManager

Returns a set of project ID / issue type combinations that given issue keys cover.

Specified by:

getProjectIssueTypePairsByKeys in interface IssueManager

Parameters:

issueKeys - Set of issue keys

Returns:

Project ID / issue type pairs

getProjectIssueTypePairsByIds

@Internal
 @Nonnull
public Set<Pair<Long,String>> getProjectIssueTypePairsByIds(@Nonnull
                                                                                Set<Long> issueIds)

Description copied from interface: IssueManager

Returns a set of project ID / issue type combinations that given issue IDs cover.

Specified by:

getProjectIssueTypePairsByIds in interface IssueManager

Parameters:

issueIds - Set of issue IDs

Returns:

Project ID / issue type pairs

getKeysOfMissingIssues

@Internal
 @Nonnull
public Set<String> getKeysOfMissingIssues(@Nonnull
                                                              Set<String> issueKeys)

Description copied from interface: IssueManager

Check existence of issues for the given set of keys

Specified by:

getKeysOfMissingIssues in interface IssueManager

Parameters:

issueKeys - Set of issue keys

Returns:

Set of invalid keys or the ones that don't represent an issue

getIdsOfMissingIssues

@Internal
 @Nonnull
public Set<Long> getIdsOfMissingIssues(@Nonnull
                                                           Set<Long> issueIds)

Description copied from interface: IssueManager

Check existence of issues for the given set of IDs

Specified by:

getIdsOfMissingIssues in interface IssueManager

Parameters:

issueIds - Set of issue IDs

Returns:

Set of IDs that don't represent an issue

getIssue

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

Deprecated.

Description copied from interface: IssueManager

Retrieves an issue by its id.

Specified by:

getIssue in interface IssueManager

Parameters:

id - Issue ID.

Returns:

An issue GenericValue.

Throws:

DataAccessException - if there is an error in the Data Access Layer.

getIssue

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

Deprecated.

Description copied from interface: IssueManager

Retrieves the issue as a GenericValue with the given key.

Specified by:

getIssue in interface IssueManager

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

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

Deprecated.

Description copied from interface: IssueManager

Retrieves an issue GenericValue given a workflow ID. This is used when transitioning through the various steps of a workflow.

Specified by:

getIssueByWorkflow in interface IssueManager

Parameters:

wfid - workflow ID.

Returns:

An issue GenericValue.

Throws:

org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

getIssueObjectByWorkflow

public MutableIssue getIssueObjectByWorkflow(Long workflowId)
                                      throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueManager

Retrieves an issue given a workflow ID. This is used when transitioning through the various steps of a workflow.

Specified by:

getIssueObjectByWorkflow in interface IssueManager

Parameters:

workflowId - workflow ID.

Returns:

The Issue

Throws:

org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

isExistingIssueKey

@ExperimentalApi
public boolean isExistingIssueKey(String issueKey)
                                            throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueManager

Returns true if issue with a given key exists (it looks for issues having current issue key set for the value, and moved issue keys that used the key).

Specified by:

isExistingIssueKey in interface IssueManager

Throws:

org.ofbiz.core.entity.GenericEntityException