com.atlassian.jira.project.ProjectManager |
Known Indirect Subclasses |
Implementations of this interface are responsible for all management of project entities within JIRA.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Converts a collection of projectIds to a list of projects.
| |||||||||||
This method is deprecated.
Use
convertToProjectObjects(java.util.Collection) instead. Since v4.4.
| |||||||||||
Creates the project in the database, and adds default project roles for this project.
| |||||||||||
Creates the project in the database, and adds default project roles for this project.
| |||||||||||
Creates a new ProjectCategory with the given name and description.
| |||||||||||
Returns all ProjectCategories, ordered by name.
| |||||||||||
Returns all project keys that are associated with
Project . | |||||||||||
This method is deprecated.
Use ProjectComponentManager instead. Deprecated in v4.0.
| |||||||||||
This method is deprecated.
Use ProjectComponentManager instead. Deprecated in v4.0.
| |||||||||||
This method is deprecated.
Use ProjectComponentManager instead. Deprecated in v4.0.
| |||||||||||
Returns the curremt issue counter for the given project.
| |||||||||||
This method is deprecated.
Use
getDefaultAssignee(Project, java.util.Collection) which allows for multiple components. Since v4.4.
| |||||||||||
Gets the default assignee for an issue given its project and list of Components.
| |||||||||||
This method is deprecated.
Please use
getDefaultAssignee(Project, ProjectComponent) . Since v4.3
| |||||||||||
Get the next issue ID from this project (transactional).
| |||||||||||
This method is deprecated.
please use
getProjectObj(Long)
| |||||||||||
This method is deprecated.
Use
getProjectObject() instead. Deprecated since v4.0.
| |||||||||||
Returns the
Project with the given project key. | |||||||||||
Returns a
Project object based on the passed in project key, not taking into account the case
of the project key. | |||||||||||
This method is deprecated.
please use the
getProjectObjByKey(String) method to return a Project object
| |||||||||||
This method is deprecated.
Please use
getProjectObjByName(String) instead. Deprecated since v4.0.
| |||||||||||
This method is deprecated.
since v4.4. Use
getAllProjectCategories() instead.
| |||||||||||
This method is deprecated.
Use
getProjectCategoryObject(Long) instead. Since v4.4.
| |||||||||||
This method is deprecated.
Use
getProjectCategoryObjectByName(String) instead. Since v4.4.
| |||||||||||
This method is deprecated.
Use
getProjectCategoryObjectByNameIgnoreCase(String) instead. Since v4.4.
| |||||||||||
Returns a project's category.
| |||||||||||
This method is deprecated.
Use
getProjectCategoryForProject(Project) instead. Since 4.4
| |||||||||||
Returns a single project category by id.
| |||||||||||
Find a project category by name.
| |||||||||||
Find a project category by name ignoring the case of the category name.
| |||||||||||
Return the total number of
Project s. | |||||||||||
Retrieves a single
Project by its id. | |||||||||||
Returns a
Project object based on the passed in project key. | |||||||||||
Returns a
Project object based on the passed in project key, not taking into account the case
of the project key. | |||||||||||
Returns a
Project object based on the passed in project name. | |||||||||||
Return all
Project s ordered by name. | |||||||||||
Returns a list of projects in a particular category.
| |||||||||||
Returns a list of projects without project category, sorted by project name
| |||||||||||
This method is deprecated.
Use
getProjectObjects() instead. Deprecated in v4.0.
| |||||||||||
This method is deprecated.
Use
getProjectsLeadBy(com.atlassian.crowd.embedded.api.User) instead
| |||||||||||
Returns a list of projects in a particular category.
| |||||||||||
This method is deprecated.
Use
getProjectsFromProjectCategory(ProjectCategory) instead. Since v4.4.
| |||||||||||
Returns all the projects that leadUser is the project lead for ordered by the name of the Project.
| |||||||||||
Returns all the projects that leadUser is the project lead for ordered by the name of the Project.
| |||||||||||
This method is deprecated.
Use
getProjectObjectsWithNoCategory() instead. Since v4.4.
| |||||||||||
This method is deprecated.
Use
getDefaultAssignee(Project, java.util.Collection) and check for DefaultAssigneeException. Since v4.4.
| |||||||||||
This method is deprecated.
Use
getDefaultAssignee(Project, java.util.Collection) and check for DefaultAssigneeException. Since v4.4.
| |||||||||||
Causes a full refresh of the project cache.
| |||||||||||
Deletes the provided project from the database.
| |||||||||||
Removes the given ProjectCategory.
| |||||||||||
Removes all issues for a particular project.
| |||||||||||
Set the project counter.
| |||||||||||
Sets a project's category.
| |||||||||||
This method is deprecated.
since v4.4. Use
setProjectCategory(com.atlassian.jira.project.Project, com.atlassian.jira.project.ProjectCategory) instead.
| |||||||||||
Updates the project provided with the new attributes passed in.
| |||||||||||
Updates the project provided with the new attributes passed in.
| |||||||||||
Updates the project provided with the new attributes passed in.
| |||||||||||
Persist an updated project category.
| |||||||||||
This method is deprecated.
Use
updateProjectCategory(ProjectCategory) instead. Since v4.4.
|
Converts a collection of projectIds to a list of projects.
Will return null if incoming collection is null.
The returned list of Project Objects will have the same sort order as the incoming collection of IDs.
projectIds | a Collection of Project IDs |
---|
This method is deprecated.
Use convertToProjectObjects(java.util.Collection)
instead. Since v4.4.
Converts a collection of projectIds to a collection of projects. Will return null if is null or blank
projectIds | a Collection of Longs |
---|
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.
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. |
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.
WARNING: In 6.0, the documentation for this method incorrectly stated that this method would
interpret the lead
as a username, when it was in fact interpreted as a userkey. The method signatures
and documentation have been updated to describe the actual behaviour.
name | The name of the new project |
---|---|
key | The project key of the new project |
description | An optional description for the project |
leadKey | The userkey 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. |
Creates a new ProjectCategory with the given name and description.
name | the Name |
---|---|
description | the Description. |
Returns all ProjectCategories, ordered by name.
DataAccessException | If any errors occur accessing the DB. |
---|
Returns all project keys that are associated with Project
.
This method is deprecated.
Use ProjectComponentManager instead. Deprecated in v4.0.
Get a component from within this project, by it's id.
id | id |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use ProjectComponentManager instead. Deprecated in v4.0.
Get a component from within this project, based on the project and the component name. NOTE: This is not cached currently.
project | project |
---|---|
name | name |
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use ProjectComponentManager instead. Deprecated in v4.0.
Returns a collection of components in a project.
project | project |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
Returns the curremt issue counter for the given project. This value is for information only; you should not use it to predict or create issue ids, because it may change concurrently as new issues are created.
id | the ID of the project for which to retrieve the counter |
---|
This method is deprecated.
Use getDefaultAssignee(Project, java.util.Collection)
which allows for multiple components. Since v4.4.
Gets the default assignee for a project and/or component depending on if a component was specified.
project | project |
---|---|
component | component |
DefaultAssigneeException | If the default assignee does NOT have ASSIGNABLE permission OR Unassigned issues are turned off. |
---|
Gets the default assignee for an issue given its project and list of Components.
If the default assignee configuration is invalid, then a DefaultAssigneeException is thrown. This could be because the default is unassigned, and unassigned issues are not allowed, or because the default user does not have permission to be assigned to issues in this project.
project | project |
---|---|
components | The components |
DefaultAssigneeException | If the default assignee is invalid (eg user does not have assign permission) . |
---|
This method is deprecated.
Please use getDefaultAssignee(Project, ProjectComponent)
. Since v4.3
Gets the default assignee for a project and/or component depending on if a component was specified.
project | project |
---|---|
component | component |
User
DefaultAssigneeException | If the default assignee does NOT have ASSIGNABLE permission OR Unassigned issues are turned off. |
---|
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.
project | The Project |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
please use getProjectObj(Long)
Retrieve a single project by it's id.
id | the Project ID. |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use getProjectObject()
instead. Deprecated since v4.0.
Returns a project GenericValue that an issue is in.
issue | the issue. |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
@Internal
or @PublicApi
.
Returns the Project
with the given project key.
This method will strictly only return the project whose current project key is the one given.
This method is added to the API in anticipation of being able to edit the project key, but this feature has not actually been added in 6.0.
projectKey | the Project key. |
---|
Project
with the given project key.Returns a Project
object based on the passed in project key, not taking into account the case
of the project key.
projectKey | the project key, case does not matter. |
---|
This method is deprecated.
please use the getProjectObjByKey(String)
method to return a Project
object
Retrieve a single project by it's project key.
key | the project key |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Please use getProjectObjByName(String)
instead. Deprecated since v4.0.
Retrieve a single project by it's project name.
name | project name |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
since v4.4. Use getAllProjectCategories()
instead.
Get all ProjectCategories.
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use getProjectCategoryObject(Long)
instead. Since v4.4.
Returns a single project category by id.
id | Project Category ID. |
---|
DataAccessException |
---|
This method is deprecated.
Use getProjectCategoryObjectByName(String)
instead. Since v4.4.
Find a project category by name. NOTE: The current implementation is not the most efficient.
projectCategoryName | Name of the Project Category |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use getProjectCategoryObjectByNameIgnoreCase(String)
instead. Since v4.4.
Find a project category by name ignoring the case of the category name. NOTE: The current implementation is not the most efficient.
projectCategoryName | Name of the Project Category |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
Returns a project's category.
project | project |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use getProjectCategoryForProject(Project)
instead. Since 4.4
Returns a project's category.
project | project |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
Returns a single project category by id.
id | Project Category ID. |
---|
DataAccessException |
---|
Find a project category by name.
projectCategoryName | Name of the Project Category |
---|
Find a project category by name ignoring the case of the category name.
projectCategoryName | Name of the Project Category |
---|
Return the total number of Project
s.
DataAccessException | if any errors occur accessing the DB. |
---|
Retrieves a single Project
by its id.
id | ID of the Project. |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
Returns a Project
object based on the passed in project key, not taking into account the case
of the project key. Matches also by previous keys that were associated with a project.
projectKey | the project key, case does not matter. |
---|
Return all Project
s ordered by name.
DataAccessException | If any errors occur accessing the DB. |
---|
Returns a list of projects in a particular category.
projectCategoryId | project category id. |
---|
Project
s sorted by name.DataAccessException | If any errors occur accessing the DB. |
---|
Returns a list of projects without project category, sorted by project name
Project
s sorted by nameDataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use getProjectObjects()
instead. Deprecated in v4.0.
Return all project GenericValues.
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use getProjectsLeadBy(com.atlassian.crowd.embedded.api.User)
instead
Returns all the projects that leadUser is the project lead for.
leadUser | Project Lead |
---|
Returns a list of projects in a particular category.
projectCategory | project category. |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use getProjectsFromProjectCategory(ProjectCategory)
instead. Since v4.4.
Returns a list of projects in a particular category.
projectCategory | project category. |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
Returns all the projects that leadUser is the project lead for ordered by the name of the Project.
leadUser | Project Lead |
---|
Returns all the projects that leadUser is the project lead for ordered by the name of the Project.
leadUser | Project Lead |
---|
This method is deprecated.
Use getProjectObjectsWithNoCategory()
instead. Since v4.4.
Returns a list of projects without project category, sorted by project name
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use getDefaultAssignee(Project, java.util.Collection)
and check for DefaultAssigneeException. Since v4.4.
Checks if there is a valid default assignee for a given project.
project | project |
---|
This method is deprecated.
Use getDefaultAssignee(Project, java.util.Collection)
and check for DefaultAssigneeException. Since v4.4.
This function checks if there is a valid default assignee set in the system
If this returns false then the getDefaultAssignee(GenericValue, GenericValue)
will throw an exception
project | project |
---|---|
component | component |
isDefaultAssignee(org.ofbiz.core.entity.GenericValue)
is trueCauses a full refresh of the project cache.
Deletes the provided project from the database.
Please note that this method only deletes the project itself and not any related entities.
Use deleteProject(User, ProjectService.DeleteProjectValidationResult)
to
properly delete a project.
project | The project to be deleted. |
---|
Removes the given ProjectCategory.
id | the ProjectCategory to remove. |
---|
Removes all issues for a particular project. A RemoveException will be thrown on any errors removing issues.
project | The project for which issues will be deleted. |
---|
RemoveException | if there's any errors removing issues |
---|
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.
project | the project for which to set the counter (required) |
---|---|
counter | the counter value to set |
Sets a project's category.
project | project |
---|---|
category | category |
DataAccessException | If any errors occur accessing the DB. |
---|---|
IllegalArgumentException | if the project provided is null |
This method is deprecated.
since v4.4. Use setProjectCategory(com.atlassian.jira.project.Project, com.atlassian.jira.project.ProjectCategory)
instead.
Sets a projects category.
project | project |
---|---|
category | category |
DataAccessException | If any errors occur accessing the DB. |
---|---|
IllegalArgumentException | if the project provided is null |
Updates the project provided with the new attributes passed in. This method is responsible for persisting any changes to the database.
originalProject | The project to be updated. |
---|---|
name | The name for the updated project |
description | An optional description for the project |
leadKey | 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. |
Updates the project provided with the new attributes passed in. This method is responsible for persisting any changes to the database.
originalProject | The project to be updated. |
---|---|
name | The name for the updated project |
description | An optional description for the project |
leadKey | 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. |
projectKey | The new project key (not updated if null) |
Updates the project provided with the new attributes passed in. This method is responsible for persisting any changes to the database.
originalProject | The project to be updated. |
---|---|
name | The name for the updated project |
description | An optional description for the project |
leadKey | 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. |
Persist an updated project category.
projectCategory | project category. |
---|
DataAccessException | If any errors occur accessing the DB. |
---|
This method is deprecated.
Use updateProjectCategory(ProjectCategory)
instead. Since v4.4.
Persist an updated project category.
projectCat | project category. |
---|
DataAccessException | If any errors occur accessing the DB. |
---|