com.atlassian.jira.mock
Class MockIssueManager

java.lang.Object
  extended by com.atlassian.jira.mock.MockIssueManager
All Implemented Interfaces:
IssueManager, JiraManager

public class MockIssueManager
extends Object
implements IssueManager


Constructor Summary
MockIssueManager()
           
 
Method Summary
 void addIssue(org.ofbiz.core.entity.GenericValue issueGV)
           
 void addIssue(MutableIssue issue)
           
 void addVersion(org.ofbiz.core.entity.GenericValue version)
           
 org.ofbiz.core.entity.GenericValue createIssue(String remoteUserName, Map fields)
          Creates an issue.
 org.ofbiz.core.entity.GenericValue createIssue(com.atlassian.crowd.embedded.api.User remoteUser, Issue issue)
          Persists a new issue.
 org.ofbiz.core.entity.GenericValue createIssue(com.atlassian.crowd.embedded.api.User remoteUser, Map fields)
          Creates an issue.
 Issue createIssueObject(String remoteUserName, Map<String,Object> fields)
          Creates an issue.
 Issue createIssueObject(com.atlassian.crowd.embedded.api.User remoteUser, Issue issue)
          Creates an issue.
 Issue createIssueObject(com.atlassian.crowd.embedded.api.User remoteUser, Map<String,Object> fields)
          Creates an issue.
 void deleteIssue(com.atlassian.crowd.embedded.api.User user, Issue issue, EventDispatchOption eventDispatchOption, boolean sendMail)
          This method will delete an issue from JIRA.
 void deleteIssue(com.atlassian.crowd.embedded.api.User user, MutableIssue issue, EventDispatchOption eventDispatchOption, boolean sendMail)
          This method will delete an issue from JIRA.
 void deleteIssueNoEvent(Issue issue)
          Delete issue without firing any events, or sending notifications.
 void deleteIssueNoEvent(MutableIssue issue)
          Delete issue without firing any events, or sending notifications.
 List execute(SearchRequest searchRequest, com.atlassian.crowd.embedded.api.User searcher)
          Takes a search request object and returns a list of issues that match the search request
 long getCacheHitsCount()
           
 long getCacheMaxSize()
           
 long getCacheMissCount()
           
 long getCacheSize()
           
 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)
          Retrieves an issue by its id.
 org.ofbiz.core.entity.GenericValue getIssue(String key)
          Retrieves the issue as a GenericValue with the given key.
 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.
 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 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 getProjectIssues(org.ofbiz.core.entity.GenericValue project)
          Get all the issues for a given project.
 long getUnassignedIssueCount()
          Returns the number of unassigned issues.
 List getVotedIssues(com.atlassian.crowd.embedded.api.User user)
          Get a list of issues that the user has voted on and can see.
 List<Issue> getVotedIssuesOverrideSecurity(com.atlassian.crowd.embedded.api.User user)
          Get a list of issues that the user has voted on.
 List<Issue> getWatchedIssues(com.atlassian.crowd.embedded.api.User user)
          Get a list of issues that the user is watching and can see.
 List<Issue> getWatchedIssuesOverrideSecurity(com.atlassian.crowd.embedded.api.User user)
          Get a list of issues that the user is watching
 List<com.atlassian.crowd.embedded.api.User> getWatchers(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, com.atlassian.crowd.embedded.api.User user)
          Returns true if the issue can be edited by the current user.
 void refresh()
           
 void refresh(org.ofbiz.core.entity.GenericValue issue)
           
 void refreshParents(String associationName, org.ofbiz.core.entity.GenericValue child)
           
 void resetCacheStats()
           
 void setCacheMaxSize(long maxSize)
           
 void setEditable(boolean editable)
           
 Issue updateIssue(com.atlassian.crowd.embedded.api.User user, MutableIssue issue, EventDispatchOption eventDispatchOption, boolean sendMail)
          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

MockIssueManager

public MockIssueManager()
Method Detail

getIssue

public org.ofbiz.core.entity.GenericValue getIssue(Long id)
                                            throws DataAccessException
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

public org.ofbiz.core.entity.GenericValue getIssue(String key)
                                            throws org.ofbiz.core.entity.GenericEntityException
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

getIssues

public List getIssues(Collection 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.

Specified by:
getIssues in interface IssueManager
Parameters:
ids - Issue IDs.
Returns:
A collection of issue GenericValues

getIssueByWorkflow

public org.ofbiz.core.entity.GenericValue getIssueByWorkflow(Long wfid)
                                                      throws org.ofbiz.core.entity.GenericEntityException
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.

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.

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.

Specified by:
getIssueObjects in interface IssueManager
Parameters:
ids - Issue IDs.
Returns:
A collection of issue MutableIssues

getEntitiesByIssue

public List 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 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 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.

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.

createIssueObject

public Issue createIssueObject(com.atlassian.crowd.embedded.api.User 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

public org.ofbiz.core.entity.GenericValue createIssue(String remoteUserName,
                                                      Map fields)
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.

createIssue

public org.ofbiz.core.entity.GenericValue createIssue(com.atlassian.crowd.embedded.api.User remoteUser,
                                                      Map fields)
                                               throws CreateException
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.

createIssue

public org.ofbiz.core.entity.GenericValue createIssue(com.atlassian.crowd.embedded.api.User remoteUser,
                                                      Issue issue)
                                               throws CreateException
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(com.atlassian.crowd.embedded.api.User 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(com.atlassian.crowd.embedded.api.User 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. 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.

deleteIssue

public void deleteIssue(com.atlassian.crowd.embedded.api.User 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

public void deleteIssue(com.atlassian.crowd.embedded.api.User user,
                        MutableIssue 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.

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 IssueManager.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:
IssueManager.deleteIssue(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.Issue, com.atlassian.jira.event.type.EventDispatchOption, boolean)

deleteIssueNoEvent

public void deleteIssueNoEvent(MutableIssue 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 IssueManager.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:
IssueManager.deleteIssue(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.MutableIssue, com.atlassian.jira.event.type.EventDispatchOption, boolean)

getProjectIssues

public List getProjectIssues(org.ofbiz.core.entity.GenericValue project)
                      throws org.ofbiz.core.entity.GenericEntityException
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.

setEditable

public void setEditable(boolean editable)

isEditable

public boolean isEditable(Issue issue,
                          com.atlassian.crowd.embedded.api.User 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 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

getVotedIssues

public List getVotedIssues(com.atlassian.crowd.embedded.api.User user)
                    throws org.ofbiz.core.entity.GenericEntityException
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.
Throws:
org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

getVotedIssuesOverrideSecurity

public List<Issue> getVotedIssuesOverrideSecurity(com.atlassian.crowd.embedded.api.User user)
                                           throws org.ofbiz.core.entity.GenericEntityException
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.
Throws:
org.ofbiz.core.entity.GenericEntityException - An exception in the ofbiz Entity Engine.

getWatchers

public List<com.atlassian.crowd.embedded.api.User> 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.

getWatchedIssues

public List<Issue> getWatchedIssues(com.atlassian.crowd.embedded.api.User 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(com.atlassian.crowd.embedded.api.User 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

addIssue

public void addIssue(org.ofbiz.core.entity.GenericValue issueGV)

addIssue

public void addIssue(MutableIssue issue)

addVersion

public void addVersion(org.ofbiz.core.entity.GenericValue version)
                throws org.ofbiz.core.entity.GenericEntityException
Throws:
org.ofbiz.core.entity.GenericEntityException

execute

public List execute(SearchRequest searchRequest,
                    com.atlassian.crowd.embedded.api.User searcher)
             throws SearchException
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
Returns:
A List of Issues that match the search request
Throws:
SearchException

refresh

public void refresh()

refresh

public void refresh(org.ofbiz.core.entity.GenericValue issue)

getCacheHitsCount

public long getCacheHitsCount()

getCacheMissCount

public long getCacheMissCount()

resetCacheStats

public void resetCacheStats()

getCacheMaxSize

public long getCacheMaxSize()

setCacheMaxSize

public void setCacheMaxSize(long maxSize)

getCacheSize

public long getCacheSize()

refreshParents

public void refreshParents(String associationName,
                           org.ofbiz.core.entity.GenericValue child)
                    throws org.ofbiz.core.entity.GenericEntityException
Throws:
org.ofbiz.core.entity.GenericEntityException


Copyright © 2002-2013 Atlassian. All Rights Reserved.