public interface ProjectConfigurationService
projects
.Modifier and Type | Method and Description |
---|---|
default @NotNull Project |
createProject(@NotNull String projectKey,
@NotNull String projectName,
@Nullable String projectDescription)
Deprecated.
since 6.9.0. Use
createProject(String, String, String, boolean) |
@NotNull Project |
createProject(@NotNull String projectKey,
@NotNull String projectName,
@Nullable String projectDescription,
boolean grantAllUsersReadAccess)
Creates and persists a new
Project , throwing an exception on invalid data. |
void |
markProjectForDeletion(@NotNull Project project)
Marks a project for deletion.
|
void |
updateProject(@NotNull Project project,
@NotNull String projectName,
@Nullable String projectDescription)
Updates and persists changes for an existing
Project , throwing exception on invalid data. |
@NotNull ErrorCollection |
validateProjectForCreation(@Nullable String projectKey,
@Nullable String projectName,
@Nullable String projectDescription)
Perform validation of data for creation of a new
Project . |
@NotNull ErrorCollection |
validateProjectForCreation(@NotNull String projectKeyField,
@Nullable String projectKey,
@NotNull String projectNameField,
@Nullable String projectName,
@NotNull String projectDescriptionField,
@Nullable String projectDescription)
Perform validation of data for creation of a new
Project . |
@NotNull ErrorCollection |
validateProjectForUpdate(@NotNull String projectKey,
@Nullable String projectName,
@Nullable String projectDescription)
Perform validation of data for updating details of an existing
Project . |
@NotNull ErrorCollection |
validateProjectForUpdate(@NotNull String projectKey,
@NotNull String projectNameField,
@Nullable String projectName,
@NotNull String projectDescriptionField,
@Nullable String projectDescription)
Perform validation of data for updating details of an existing
Project . |
@NotNull @NotNull ErrorCollection validateProjectForCreation(@Nullable @Nullable String projectKey, @Nullable @Nullable String projectName, @Nullable @Nullable String projectDescription)
Project
.projectKey
- key of the projectprojectName
- project nameprojectDescription
- project description@NotNull @NotNull ErrorCollection validateProjectForCreation(@NotNull @NotNull String projectKeyField, @Nullable @Nullable String projectKey, @NotNull @NotNull String projectNameField, @Nullable @Nullable String projectName, @NotNull @NotNull String projectDescriptionField, @Nullable @Nullable String projectDescription)
Project
.
This is a more specific version of validateProjectForCreation(String, String, String)
, allowing
configuration of field names to generate more accurate ErrorCollection
.
projectKeyField
- field used to configure project keyprojectKey
- key of the projectprojectNameField
- field used to configure project nameprojectName
- project nameprojectDescriptionField
- field used to configure project descriptionprojectDescription
- project description@NotNull @Deprecated default @NotNull Project createProject(@NotNull @NotNull String projectKey, @NotNull @NotNull String projectName, @Nullable @Nullable String projectDescription) throws WebValidationException
createProject(String, String, String, boolean)
Project
, throwing an exception on invalid data. Prior to calling this method
data should be validated by calling validateProjectForCreation(String, String, String)
.projectKey
- key of the projectprojectName
- project nameprojectDescription
- project descriptionWebValidationException
- in case of validation errors@NotNull @NotNull Project createProject(@NotNull @NotNull String projectKey, @NotNull @NotNull String projectName, @Nullable @Nullable String projectDescription, boolean grantAllUsersReadAccess) throws WebValidationException
Project
, throwing an exception on invalid data. Prior to calling this method
data should be validated by calling validateProjectForCreation(String, String, String)
.projectKey
- key of the projectprojectName
- project nameprojectDescription
- project descriptiongrantAllUsersReadAccess
- grant anonymous and logged-in users READ permissionsWebValidationException
- in case of validation errors@NotNull @NotNull ErrorCollection validateProjectForUpdate(@NotNull @NotNull String projectKey, @Nullable @Nullable String projectName, @Nullable @Nullable String projectDescription)
Project
.projectKey
- key of the projectprojectName
- new project nameprojectDescription
- new project description@NotNull @NotNull ErrorCollection validateProjectForUpdate(@NotNull @NotNull String projectKey, @NotNull @NotNull String projectNameField, @Nullable @Nullable String projectName, @NotNull @NotNull String projectDescriptionField, @Nullable @Nullable String projectDescription)
Project
.
This is a more specific version of validateProjectForUpdate(String, String, String)
, allowing
configuration of field names to generate more accurate ErrorCollection
.
projectKey
- key of the projectprojectNameField
- field used to configure project nameprojectName
- new project nameprojectDescriptionField
- field used to configure project descriptionprojectDescription
- new project descriptionvoid updateProject(@NotNull @NotNull Project project, @NotNull @NotNull String projectName, @Nullable @Nullable String projectDescription) throws WebValidationException
Project
, throwing exception on invalid data. Prior to calling
this method data should be validated by calling validateProjectForUpdate(String, String, String)
.project
- project to updateprojectName
- new project nameprojectDescription
- new project descriptionWebValidationException
- in case of validation errorsvoid markProjectForDeletion(@NotNull @NotNull Project project) throws IllegalStateException
project
- project to deleteIllegalStateException
- in case of illegal state of the projectCopyright © 2023 Atlassian Software Systems Pty Ltd. All rights reserved.