com.atlassian.jira.project
Class DefaultProjectManager

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

public class DefaultProjectManager
extends AbstractProjectManager

A class to manage interactions with projects


Constructor Summary
DefaultProjectManager()
          Don't use this constructor.
DefaultProjectManager(OfBizDelegator delegator, com.atlassian.core.ofbiz.association.AssociationManager associationManager, ProjectFactory projectFactory, ProjectRoleManager projectRoleManager, IssueManager issueManager, com.atlassian.core.action.ActionDispatcher actionDispatcher, AvatarManager avatarManager)
           
 
Method Summary
 Project createProject(java.lang.String name, java.lang.String key, java.lang.String description, java.lang.String lead, java.lang.String url, java.lang.Long assigneeType, java.lang.Long avatarId)
          Creates the project in the database, and adds default project roles for this project.
 org.ofbiz.core.entity.GenericValue getComponent(org.ofbiz.core.entity.GenericValue project, java.lang.String name)
          Deprecated. use ProjectComponentManager instead
 org.ofbiz.core.entity.GenericValue getComponent(java.lang.Long id)
          Deprecated. use ProjectComponentManager instead
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getComponents(org.ofbiz.core.entity.GenericValue project)
          Deprecated. use ProjectComponentManager instead
protected  OfBizDelegator getDelegator()
           
 long getNextId(org.ofbiz.core.entity.GenericValue project)
          Get the next issue ID from this project (transactional).
 org.ofbiz.core.entity.GenericValue getProject(java.lang.Long id)
          Retrieve a single project by it's id.
 org.ofbiz.core.entity.GenericValue getProjectByKey(java.lang.String key)
          Retrieve a single project by it's project key.
 org.ofbiz.core.entity.GenericValue getProjectByName(java.lang.String name)
          Retrieve a single project by it's project name.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjectCategories()
          Get all ProjectCategories.
 org.ofbiz.core.entity.GenericValue getProjectCategory(java.lang.Long id)
          Returns a single project category by id.
 org.ofbiz.core.entity.GenericValue getProjectCategoryFromProject(org.ofbiz.core.entity.GenericValue project)
          Get the Project Category given a Project.
 Project getProjectObj(java.lang.Long id)
          Retrieves a single Project by its id.
 Project getProjectObjByKey(java.lang.String projectKey)
          Returns a Project object based on the passed in project key.
 Project getProjectObjByKeyIgnoreCase(java.lang.String projectKey)
          Returns a Project object based ont he passed in project key, not taking into account the case of the project key.
 Project getProjectObjByName(java.lang.String projectName)
          Returns a Project object based on the passed in project name.
 java.util.List<Project> getProjectObjects()
          Return all Projects ordered by name.
 java.util.Collection<Project> getProjectObjectsFromProjectCategory(java.lang.Long projectCategoryId)
          Returns a list of projects in a particular category.
 java.util.Collection<Project> getProjectObjectsWithNoCategory()
          Returns a list of projects without project category, sorted by project name
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjects()
          Return all project GenericValues.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjectsByLead(com.opensymphony.user.User leadUser)
          Returns all the projects that leadUser is the project lead for.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjectsFromProjectCategory(org.ofbiz.core.entity.GenericValue projectCategory)
          Gather a list of projects that are in a project category.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjectsWithNoCategory()
          Gets a list of projects that are not associated with any project category
 void refresh()
          Causes a full refresh of the project cache.
 void refreshProjectDependencies(org.ofbiz.core.entity.GenericValue project)
          This will refresh the dependencies of a project.
 void removeProject(Project project)
          Deletes the provided project from the database.
 void removeProjectIssues(Project project)
          Removes all issues for a particular project.
 void setProjectCategory(org.ofbiz.core.entity.GenericValue project, org.ofbiz.core.entity.GenericValue category)
          If category is non-null, set project's Project Category to category.
 void updateProject(org.ofbiz.core.entity.GenericValue updatedProject)
          Persists a project GenericValue to the database.
 Project updateProject(Project updatedProject, java.lang.String name, java.lang.String description, java.lang.String lead, java.lang.String url, java.lang.Long assigneeType, java.lang.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.
 
Methods inherited from class com.atlassian.jira.project.AbstractProjectManager
convertToProjects, createProject, getComponents, getDefaultAssignee, getNextId, getProject, getProjectCategoryByName, getProjectCategoryByNameIgnoreCase, isDefaultAssignee, isDefaultAssignee, updateProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultProjectManager

public DefaultProjectManager()
Don't use this constructor.

Use ManagerFactory.getProjectManager() instead.


DefaultProjectManager

public DefaultProjectManager(OfBizDelegator delegator,
                             com.atlassian.core.ofbiz.association.AssociationManager associationManager,
                             ProjectFactory projectFactory,
                             ProjectRoleManager projectRoleManager,
                             IssueManager issueManager,
                             com.atlassian.core.action.ActionDispatcher actionDispatcher,
                             AvatarManager avatarManager)
Method Detail

createProject

public Project createProject(java.lang.String name,
                             java.lang.String key,
                             java.lang.String description,
                             java.lang.String lead,
                             java.lang.String url,
                             java.lang.Long assigneeType,
                             java.lang.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 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.

getNextId

public long getNextId(org.ofbiz.core.entity.GenericValue project)
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 - project GenericValue
Returns:
A long value representing a new issue id for the project.

updateProject

public void updateProject(org.ofbiz.core.entity.GenericValue updatedProject)
Description copied from interface: ProjectManager
Persists a project GenericValue to the database.

Parameters:
updatedProject - Project details to update.

updateProject

public Project updateProject(Project updatedProject,
                             java.lang.String name,
                             java.lang.String description,
                             java.lang.String lead,
                             java.lang.String url,
                             java.lang.Long assigneeType,
                             java.lang.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 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.opensymphony.user.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(java.lang.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(java.lang.Long id)
Description copied from interface: ProjectManager
Retrieves a single Project by its id.

Parameters:
id - ID of the Project.
Returns:
Project object or null if project with that id doesn't exist.

getProjectByName

public org.ofbiz.core.entity.GenericValue getProjectByName(java.lang.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(java.lang.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(java.lang.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(java.lang.String projectKey)
Description copied from interface: ProjectManager
Returns a Project object based ont he 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(java.lang.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

getComponent

@Deprecated
public org.ofbiz.core.entity.GenericValue getComponent(java.lang.Long id)
Deprecated. use ProjectComponentManager instead

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

@Deprecated
public org.ofbiz.core.entity.GenericValue getComponent(org.ofbiz.core.entity.GenericValue project,
                                                                  java.lang.String name)
Deprecated. use ProjectComponentManager instead

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

@Deprecated
public java.util.Collection<org.ofbiz.core.entity.GenericValue> getComponents(org.ofbiz.core.entity.GenericValue project)
Deprecated. use ProjectComponentManager instead

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)

getProjects

public java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjects()
Return all project GenericValues.

Returns:
all projects as Collection

getProjectObjects

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

Returns:
all projects ordered by name.
Throws:
DataAccessException - If any errors occur accessing the DB.

getDelegator

protected OfBizDelegator getDelegator()

getProjectCategories

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

Returns:
A collection of category GenericValues

getProjectCategory

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

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

updateProjectCategory

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

Parameters:
projectCat - project category.

getProjectsFromProjectCategory

public java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjectsFromProjectCategory(org.ofbiz.core.entity.GenericValue projectCategory)
Gather a list of projects that are in a project category.

Parameters:
projectCategory - Project to look up against
Returns:
Collection of Projects

getProjectObjectsFromProjectCategory

public java.util.Collection<Project> getProjectObjectsFromProjectCategory(java.lang.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 java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjectsWithNoCategory()
Gets a list of projects that are not associated with any project category

Returns:
A collection of project GenericValues sorted by name

getProjectObjectsWithNoCategory

public java.util.Collection<Project> getProjectObjectsWithNoCategory()
                                                              throws DataAccessException
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
Throws:
DataAccessException - If any errors occur accessing the DB.

getProjectCategoryFromProject

public org.ofbiz.core.entity.GenericValue getProjectCategoryFromProject(org.ofbiz.core.entity.GenericValue project)
Get the Project Category given a Project.

Parameters:
project - Project
Returns:
Project Category

setProjectCategory

public void setProjectCategory(org.ofbiz.core.entity.GenericValue project,
                               org.ofbiz.core.entity.GenericValue category)
If category is non-null, set project's Project Category to category. If category is null, remove project's Project Category association, if one exists.

Parameters:
project - project
category - category

getProjectsByLead

public java.util.Collection<org.ofbiz.core.entity.GenericValue> getProjectsByLead(com.opensymphony.user.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 TODO: deprecate this method.

refreshProjectDependencies

public void refreshProjectDependencies(org.ofbiz.core.entity.GenericValue project)
Description copied from interface: ProjectManager
This will refresh the dependencies of a project. Please do not use this to refresh the passed in project in the project cache. use ProjectManager.refresh()

Parameters:
project - project GenericValue

refresh

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



Copyright © 2002-2010 Atlassian. All Rights Reserved.