Package com.atlassian.jira.bc.project.component

Interface ProjectComponentService

All Known Implementing Classes:

DefaultProjectComponentService

@PublicApi
public interface ProjectComponentService

Method Summary

Modifier and Type	Method	Description
ProjectComponent	create(ApplicationUser user, ErrorCollection errorCollection, String name, String description, String lead, Long projectId)	Deprecated. since 6.3, use #create(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.util.ErrorCollection, String, String, String, Long, Long) instead
ProjectComponent	create(ApplicationUser user, ErrorCollection errorCollection, String name, String description, String lead, Long projectId, Long assigneeType)	Create a project component with assignee type set as provided.
void	deleteAndSwapComponentForIssues(JiraServiceContext context, Long componentId, Long swapComponentId)
void	deleteComponentForIssues(JiraServiceContext context, Long componentId)
ProjectComponent	find(ApplicationUser user, ErrorCollection errorCollection, Long id)
Collection<ProjectComponent>	findAllForProject(ErrorCollection errorCollection, Long projectId)
Stream<ProjectComponent>	findComponents(ApplicationUser user, String substring, List<Long> projectIds)	Returns components whose names start with or fully match given substring.
ProjectComponent	update(ApplicationUser user, ErrorCollection errorCollection, MutableProjectComponent component)

Method Details

create

@Deprecated
ProjectComponent create(ApplicationUser user,
 ErrorCollection errorCollection,
 String name,
 String description,
 String lead,
 Long projectId)

Deprecated.

since 6.3, use #create(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.util.ErrorCollection, String, String, String, Long, Long) instead

Create a project component and use default assignee type (project default).

Returns:

A newly created project component ProjectComponent

create

ProjectComponent create(ApplicationUser user,
 ErrorCollection errorCollection,
 String name,
 String description,
 String lead,
 Long projectId,
 Long assigneeType)

Create a project component with assignee type set as provided.

Returns:

A newly created project component ProjectComponent

find

ProjectComponent find(ApplicationUser user,
 ErrorCollection errorCollection,
 Long id)

findAllForProject

Collection<ProjectComponent> findAllForProject(ErrorCollection errorCollection,
 Long projectId)

update

ProjectComponent update(ApplicationUser user,
 ErrorCollection errorCollection,
 MutableProjectComponent component)

deleteComponentForIssues

void deleteComponentForIssues(JiraServiceContext context,
 Long componentId)

deleteAndSwapComponentForIssues

void deleteAndSwapComponentForIssues(JiraServiceContext context,
 Long componentId,
 Long swapComponentId)

findComponents

@ExperimentalApi
Stream<ProjectComponent> findComponents(@Nullable
 ApplicationUser user,
 @Nonnull
 String substring,
 @Nonnull
 List<Long> projectIds)

Returns components whose names start with or fully match given substring. Components that the calling user has no permissions to see or archived components are filtered out.

Parameters:

user - the calling user

substring - the string that component names will be matched with

projectIds - the list of project ids to filter components

Since:

9.2