com.atlassian.jira.mock
Class MockProjectManager

java.lang.Object
  extended by com.atlassian.jira.project.AbstractProjectManager
      extended by com.atlassian.jira.mock.MockProjectManager
All Implemented Interfaces:
ProjectManager

public class MockProjectManager
extends AbstractProjectManager


Constructor Summary
MockProjectManager()
           
 
Method Summary
 void addProject(org.ofbiz.core.entity.GenericValue gv)
           
 void addProject(Project project)
           
static MockProjectManager createDefaultProjectManager()
          Creates a "default" MockProjectManager.
 Project createProject(String name, String key, String description, String lead, String url, Long assigneeType, Long avatarId)
          Creates the project in the database, and adds default project roles for this project.
 ProjectCategory createProjectCategory(String name, String description)
          Creates a new ProjectCategory with the given name and description.
 Collection<ProjectCategory> getAllProjectCategories()
          Returns all ProjectCategories, ordered by name.
 org.ofbiz.core.entity.GenericValue getComponent(org.ofbiz.core.entity.GenericValue project, String name)
          Get a component from within this project, based on the project and the component name.
 org.ofbiz.core.entity.GenericValue getComponent(Long id)
          Get a component from within this project, by it's id.
 Collection<org.ofbiz.core.entity.GenericValue> getComponents(org.ofbiz.core.entity.GenericValue project)
          Returns a collection of components in a project.
 long getCurrentCounterForProject(Long id)
          This is for informational purposes only.
 long getNextId(Project project)
          Get the next issue ID from this project (transactional).
 org.ofbiz.core.entity.GenericValue getProject(Long id)
          Retrieve a single project by it's id.
 org.ofbiz.core.entity.GenericValue getProjectByKey(String key)
          Retrieve a single project by it's project key.
 org.ofbiz.core.entity.GenericValue getProjectByName(String name)
          Retrieve a single project by it's project name.
 Collection<org.ofbiz.core.entity.GenericValue> getProjectCategories()
          Get all ProjectCategories.
 org.ofbiz.core.entity.GenericValue getProjectCategory(Long id)
          Returns a single project category by id.
 ProjectCategory getProjectCategoryForProject(Project project)
          Returns a project's category.
 org.ofbiz.core.entity.GenericValue getProjectCategoryFromProject(org.ofbiz.core.entity.GenericValue project)
          Returns a project's category.
 ProjectCategory getProjectCategoryObject(Long id)
          Returns a single project category by id.
 long getProjectCount()
          Return the total number of Projects.
 Project getProjectObj(Long id)
          Returns project object or null if project with that id doesn't exist.
 Project getProjectObjByKey(String projectKey)
          Returns a Project object based on the passed in project key.
 Project getProjectObjByKeyIgnoreCase(String projectKey)
          Returns a Project object based on the passed in project key, not taking into account the case of the project key.
 Project getProjectObjByName(String projectName)
          Returns a Project object based on the passed in project name.
 List<Project> getProjectObjects()
          Return all Projects ordered by name.
 Collection<Project> getProjectObjectsFromProjectCategory(Long projectCategoryId)
          Returns a list of projects in a particular category.
 Collection<Project> getProjectObjectsWithNoCategory()
          Returns a list of projects without project category, sorted by project name
 Collection<org.ofbiz.core.entity.GenericValue> getProjects()
          Return all project GenericValues.
 Collection<org.ofbiz.core.entity.GenericValue> getProjectsByLead(com.atlassian.crowd.embedded.api.User leadUser)
          Returns all the projects that leadUser is the project lead for.
 Collection<org.ofbiz.core.entity.GenericValue> getProjectsFromProjectCategory(org.ofbiz.core.entity.GenericValue projectCategory)
          Returns a list of projects in a particular category.
 Collection<Project> getProjectsFromProjectCategory(ProjectCategory projectCategory)
          Returns a list of projects in a particular category.
 List<Project> getProjectsLeadBy(ApplicationUser leadUser)
          Returns all the projects that leadUser is the project lead for ordered by the name of the Project.
 List<Project> getProjectsLeadBy(com.atlassian.crowd.embedded.api.User leadUser)
          Returns all the projects that leadUser is the project lead for ordered by the name of the Project.
 Collection<org.ofbiz.core.entity.GenericValue> getProjectsWithNoCategory()
          Returns a list of projects without project category, sorted by project name
 void refresh()
          Causes a full refresh of the project cache.
 void removeProject(Project project)
          Deletes the provided project from the database.
 void removeProjectCategory(Long id)
          Removes the given ProjectCategory.
 void removeProjectIssues(Project project)
          Removes all issues for a particular project.
 void setCurrentCounterForProject(Project project, long counter)
          Set the project counter.
 void setProjectCategory(org.ofbiz.core.entity.GenericValue project, org.ofbiz.core.entity.GenericValue category)
          Sets a projects category.
 void setProjectCategory(Project project, ProjectCategory category)
          Sets a project's category.
 Project updateProject(Project updatedProject, String name, String description, String lead, String url, Long assigneeType, Long avatarId)
          Updates the project provided with the new attributes passed in.
 void updateProjectCategory(org.ofbiz.core.entity.GenericValue projectCat)
          Persist an updated project category.
 void updateProjectCategory(ProjectCategory projectCategory)
          Persist an updated project category.
 
Methods inherited from class com.atlassian.jira.project.AbstractProjectManager
convertToProjectObjects, convertToProjects, createProject, getDefaultAssignee, getDefaultAssignee, getDefaultAssignee, getProject, getProjectByCurrentKey, getProjectByPreviousKey, getProjectCategoryByName, getProjectCategoryByNameIgnoreCase, getProjectCategoryObjectByName, getProjectCategoryObjectByNameIgnoreCase, isDefaultAssignee, isDefaultAssignee, updateProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MockProjectManager

public MockProjectManager()
Method Detail

addProject

public void addProject(Project project)

addProject

public void addProject(org.ofbiz.core.entity.GenericValue gv)

createProject

public Project createProject(String name,
                             String key,
                             String description,
                             String lead,
                             String url,
                             Long assigneeType,
                             Long avatarId)
Description copied from interface: ProjectManager
Creates the project in the database, and adds default project roles for this project. If no name, key or lead are provided an exception will be thrown.

Parameters:
name - The name of the new project
key - The project key of the new project
description - An optional description for the project
lead - The username of the lead developer for the project
url - An optional URL for the new project
assigneeType - The default assignee for issues created in this project. May be either project lead, or unassigned if unassigned issues are enabled.
avatarId - the id of an existing system avatar.
Returns:
The newly created project.

updateProject

public Project updateProject(Project updatedProject,
                             String name,
                             String description,
                             String lead,
                             String url,
                             Long assigneeType,
                             Long avatarId)
Description copied from interface: ProjectManager
Updates the project provided with the new attributes passed in. This method is responsible for persisting any changes to the database.

Parameters:
updatedProject - The project to be updated.
name - The name for the updated project
description - An optional description for the project
lead - The userkey of the lead developer for the project
url - An optional URL for the updated project
assigneeType - The default assignee for issues created in this project. May be either project lead, or unassigned if unassigned issues are enabled.
avatarId - the id of an existing avatar.
Returns:
The updated project

removeProjectIssues

public void removeProjectIssues(Project project)
                         throws RemoveException
Description copied from interface: ProjectManager
Removes all issues for a particular project. A RemoveException will be thrown on any errors removing issues.

Parameters:
project - The project for which issues will be deleted.
Throws:
RemoveException - if there's any errors removing issues

removeProject

public void removeProject(Project project)
Description copied from interface: ProjectManager
Deletes the provided project from the database. Please note that this method only deletes the project itself and not any related entities. Use ProjectService.deleteProject(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.bc.project.ProjectService.DeleteProjectValidationResult) to properly delete a project.

Parameters:
project - The project to be deleted.

getProject

public org.ofbiz.core.entity.GenericValue getProject(Long id)
Description copied from interface: ProjectManager
Retrieve a single project by it's id.

Parameters:
id - the Project ID.
Returns:
GenericValue representation of a Project.

getProjectObj

public Project getProjectObj(Long id)
Returns project object or null if project with that id doesn't exist.

Parameters:
id - project id
Returns:
project object or null if project with that id doesn't exist

getProjectByName

public org.ofbiz.core.entity.GenericValue getProjectByName(String name)
Description copied from interface: ProjectManager
Retrieve a single project by it's project name.

Parameters:
name - project name
Returns:
GenericValue representation of a Project.

getProjectByKey

public org.ofbiz.core.entity.GenericValue getProjectByKey(String key)
Description copied from interface: ProjectManager
Retrieve a single project by it's project key.

Parameters:
key - the project key
Returns:
GenericValue representation of a Project.

getProjectObjByKey

public Project getProjectObjByKey(String projectKey)
Description copied from interface: ProjectManager
Returns a Project object based on the passed in project key.

Parameters:
projectKey - the Project key.
Returns:
the Project object specified by the key or null

getProjectObjByKeyIgnoreCase

public Project getProjectObjByKeyIgnoreCase(String projectKey)
Description copied from interface: ProjectManager
Returns a Project object based on the passed in project key, not taking into account the case of the project key.

Parameters:
projectKey - the project key, case does not matter.
Returns:
the project object specified by the key or null if not such project exists.

getProjectObjByName

public Project getProjectObjByName(String projectName)
Description copied from interface: ProjectManager
Returns a Project object based on the passed in project name.

Parameters:
projectName - the name of the project
Returns:
the Project object specified by the supplied name or null

getProjects

public Collection<org.ofbiz.core.entity.GenericValue> getProjects()
Description copied from interface: ProjectManager
Return all project GenericValues.

Returns:
all projects as Collection

getProjectObjects

public List<Project> getProjectObjects()
Description copied from interface: ProjectManager
Return all Projects ordered by name.

Returns:
all projects ordered by name.

getProjectCount

public long getProjectCount()
                     throws DataAccessException
Description copied from interface: ProjectManager
Return the total number of Projects.

Returns:
A long value representing tht total number of projects.
Throws:
DataAccessException - if any errors occur accessing the DB.

getComponent

public org.ofbiz.core.entity.GenericValue getComponent(Long id)
Description copied from interface: ProjectManager
Get a component from within this project, by it's id.

Parameters:
id - id
Returns:
A component GenericValue.
See Also:
ProjectComponentManager.find(Long)

getComponent

public org.ofbiz.core.entity.GenericValue getComponent(org.ofbiz.core.entity.GenericValue project,
                                                       String name)
Description copied from interface: ProjectManager
Get a component from within this project, based on the project and the component name. NOTE: This is not cached currently.

Parameters:
project - project
name - name
Returns:
A component GenericValue.
See Also:
ProjectComponentManager.findByComponentName(java.lang.Long, java.lang.String)

getComponents

public Collection<org.ofbiz.core.entity.GenericValue> getComponents(org.ofbiz.core.entity.GenericValue project)
Description copied from interface: ProjectManager
Returns a collection of components in a project.

Parameters:
project - project
Returns:
A collection of GenericValues.
See Also:
ProjectComponentManager.findAllForProject(java.lang.Long)

getProjectCategories

public Collection<org.ofbiz.core.entity.GenericValue> getProjectCategories()
Description copied from interface: ProjectManager
Get all ProjectCategories.

Returns:
A collection of category GenericValues

getAllProjectCategories

public Collection<ProjectCategory> getAllProjectCategories()
Description copied from interface: ProjectManager
Returns all ProjectCategories, ordered by name.

Returns:
all ProjectCategories, ordered by name.

getProjectCategory

public org.ofbiz.core.entity.GenericValue getProjectCategory(Long id)
Description copied from interface: ProjectManager
Returns a single project category by id.

Parameters:
id - Project Category ID.
Returns:
A category GenericValue

getProjectCategoryObject

public ProjectCategory getProjectCategoryObject(Long id)
                                         throws DataAccessException
Description copied from interface: ProjectManager
Returns a single project category by id.

Parameters:
id - Project Category ID.
Returns:
The project category
Throws:
DataAccessException

updateProjectCategory

public void updateProjectCategory(org.ofbiz.core.entity.GenericValue projectCat)
Description copied from interface: ProjectManager
Persist an updated project category.

Parameters:
projectCat - project category.

updateProjectCategory

public void updateProjectCategory(ProjectCategory projectCategory)
                           throws DataAccessException
Description copied from interface: ProjectManager
Persist an updated project category.

Parameters:
projectCategory - project category.
Throws:
DataAccessException - If any errors occur accessing the DB.

getProjectsFromProjectCategory

public Collection<org.ofbiz.core.entity.GenericValue> getProjectsFromProjectCategory(org.ofbiz.core.entity.GenericValue projectCategory)
Description copied from interface: ProjectManager
Returns a list of projects in a particular category.

Parameters:
projectCategory - project category.
Returns:
A collection of project GenericValues sorted by name.

getProjectsFromProjectCategory

public Collection<Project> getProjectsFromProjectCategory(ProjectCategory projectCategory)
                                                   throws DataAccessException
Description copied from interface: ProjectManager
Returns a list of projects in a particular category.

Parameters:
projectCategory - project category.
Returns:
A collection of projects sorted by name.
Throws:
DataAccessException - If any errors occur accessing the DB.

getProjectObjectsFromProjectCategory

public Collection<Project> getProjectObjectsFromProjectCategory(Long projectCategoryId)
Description copied from interface: ProjectManager
Returns a list of projects in a particular category.

Parameters:
projectCategoryId - project category id.
Returns:
A collection of project Projects sorted by name.

getProjectsWithNoCategory

public Collection<org.ofbiz.core.entity.GenericValue> getProjectsWithNoCategory()
Description copied from interface: ProjectManager
Returns a list of projects without project category, sorted by project name

Returns:
A collection of project GenericValues sorted by name

getProjectObjectsWithNoCategory

public Collection<Project> getProjectObjectsWithNoCategory()
Description copied from interface: ProjectManager
Returns a list of projects without project category, sorted by project name

Returns:
A collection of Projects sorted by name

getProjectCategoryFromProject

public org.ofbiz.core.entity.GenericValue getProjectCategoryFromProject(org.ofbiz.core.entity.GenericValue project)
Description copied from interface: ProjectManager
Returns a project's category.

Parameters:
project - project
Returns:
A category GenericValue or null if no category exists.

getProjectCategoryForProject

public ProjectCategory getProjectCategoryForProject(Project project)
Description copied from interface: ProjectManager
Returns a project's category.

Parameters:
project - project
Returns:
A ProjectCategory or null if this project has no category.

setProjectCategory

public void setProjectCategory(org.ofbiz.core.entity.GenericValue project,
                               org.ofbiz.core.entity.GenericValue category)
Description copied from interface: ProjectManager
Sets a projects category.

Parameters:
project - project
category - category

setProjectCategory

public void setProjectCategory(Project project,
                               ProjectCategory category)
Description copied from interface: ProjectManager
Sets a project's category.

Parameters:
project - project
category - category

createProjectCategory

public ProjectCategory createProjectCategory(String name,
                                             String description)
Description copied from interface: ProjectManager
Creates a new ProjectCategory with the given name and description.

Parameters:
name - the Name
description - the Description.
Returns:
the new ProjectCategory.

removeProjectCategory

public void removeProjectCategory(Long id)
Description copied from interface: ProjectManager
Removes the given ProjectCategory.

Parameters:
id - the ProjectCategory to remove.

getProjectsLeadBy

public List<Project> getProjectsLeadBy(com.atlassian.crowd.embedded.api.User leadUser)
Description copied from interface: ProjectManager
Returns all the projects that leadUser is the project lead for ordered by the name of the Project.

Parameters:
leadUser - Project Lead
Returns:
A collection of projects

getProjectsLeadBy

public List<Project> getProjectsLeadBy(ApplicationUser leadUser)
Description copied from interface: ProjectManager
Returns all the projects that leadUser is the project lead for ordered by the name of the Project.

Parameters:
leadUser - Project Lead
Returns:
A collection of projects

getProjectsByLead

public Collection<org.ofbiz.core.entity.GenericValue> getProjectsByLead(com.atlassian.crowd.embedded.api.User leadUser)
Description copied from interface: ProjectManager
Returns all the projects that leadUser is the project lead for.

Parameters:
leadUser - Project Lead
Returns:
A collection of project GenericValues

getNextId

public long getNextId(Project project)
               throws DataAccessException
Description copied from interface: ProjectManager
Get the next issue ID from this project (transactional). Each project maintains an internal counter for the number of issues. This method may be used to construct a new issue key.

Parameters:
project - The Project
Returns:
A long value representing a new issue id for the project.
Throws:
DataAccessException - If any errors occur accessing the DB.

getCurrentCounterForProject

public long getCurrentCounterForProject(Long id)
Description copied from interface: ProjectManager
This is for informational purposes only. You should not use this to predict or create issue ids, because this value may change concurrently as new issues are created.

Returns:
the current project counter (the id of the next issue to be created).

setCurrentCounterForProject

public void setCurrentCounterForProject(Project project,
                                        long counter)
Description copied from interface: ProjectManager
Set the project counter. Warning Setting the project counter is not needed in the normal operations of JIRA, this method exist for functionality like project-import etc.


refresh

public void refresh()
Description copied from interface: ProjectManager
Causes a full refresh of the project cache.


createDefaultProjectManager

public static MockProjectManager createDefaultProjectManager()
Creates a "default" MockProjectManager.

This will include the following projects:

IDKey Name
1 HSP Homosapien
2 MNK Monkey
3 RAT Rattus
4 COW Bovine
5 DOG Canine
6 PIG Porcine

Returns:
a "default" MockProjectManager.


Copyright © 2002-2013 Atlassian. All Rights Reserved.