Package com.atlassian.jira.bc.project.version

Interface VersionService

All Known Implementing Classes:
DefaultVersionService
@PublicApi public interface VersionService
Service for VersionService
Since:
v3.13

  • Field Details

  • Method Details

    • setVersionDetails

      @Deprecated ServiceOutcome<Version> setVersionDetails(ApplicationUser user, Version version, String name, String description)
      Deprecated.
      Use validateUpdate(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilder). Since v6.4
      Set the name and description of a version, if you have edit permission.
      Parameters:
      user - the user who is performing the edit operation
      version - the version that they want to edit
      name - the new name for the version (must not be null or already in use)
      description - the new description for the version
      Returns:
      a ServiceOutcome that contains the success or failure of the update
      Throws:
      IllegalArgumentException - if the name is null or duplicates an existing name

    • setReleaseDate

      @Deprecated ServiceOutcome<Version> setReleaseDate(ApplicationUser user, Version version, Date releaseDate)
      Deprecated.
      Use validateUpdate(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilder). Since v6.4
      Modify the release date of a version without performing a release/unrelease.
      Parameters:
      user - the user who is changing the release date
      version - the version they want to modify
      releaseDate - the new release date to use
      Returns:
      a ServiceOutcome describing the success/failure of the edit, along with the new Version if successful

    • setReleaseDate

      @Deprecated ServiceOutcome<Version> setReleaseDate(ApplicationUser user, Version version, String releaseDate)
      Deprecated.
      Use validateUpdate(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilder). Since v6.4
      Modify the release date of a version without performing a release/unrelease.
      Parameters:
      user - the user who is changing the release date
      version - the version they want to modify
      releaseDate - the new release date to use
      Returns:
      a ServiceOutcome describing the success/failure of the edit, along with the new Version if successful

    • validateDelete

      VersionService.ValidationResult validateDelete(JiraServiceContext context, Long versionId, VersionService.VersionAction affectsAction, VersionService.VersionAction fixAction)
      Deprecated.
      Use deleteVersionAndSwap(JiraServiceContext, DeleteVersionWithCustomFieldParameters) that supports swapping version in custom fields. Since v7.0.10
      Validates an attempt to delete a version from a project. When deleting a version, we need to decide what to do with issues that reference the version in their Affects of Fix Version fields. The action taken is specified as a flag for each field.
      Parameters:
      context - The context for this service call.
      versionId - The id of the version to be deleted.
      affectsAction - Used to decide whether to move all the issues to a different 'affects' version or just remove them. See VersionKeys.REMOVE_ACTION, VersionKeys.SWAP_ACTION
      fixAction - Used to decide wether to move all the issues to a different 'fix' version or just remove them. See VersionKeys.REMOVE_ACTION, VersionKeys.SWAP_ACTION
      Returns:
      a VersionService.ValidationResult object which contains the version to delete, and the versions to swap to for Affects and Fix versions, or null if the action to be taken is VersionKeys.REMOVE_ACTION

    • validateMerge

      VersionService.ValidationResult validateMerge(JiraServiceContext context, Long versionId, Long swapVersionId)
      Validates an attempt to merge a version into another. Merging is essentially the same as Deleting with the actions set to VersionKeys.SWAP_ACTION.
      Parameters:
      context - The context for this service call.
      versionId - The original version to be merged and removed.
      swapVersionId - The target version of the merge operation. Must be from the same project.
      Returns:
      a VersionService.ValidationResult object which contains the version to delete, and the versions to swap to for Affects and Fix versions, or null if the action to be taken is VersionKeys.REMOVE_ACTION

    • merge

      void merge(JiraServiceContext context, VersionService.ValidationResult result)
      Merges a version into another, then removes the original version.
      Parameters:
      context - The context for this service call.
      result - The result of validation, which contains the version to be deleted, and the swap versions for Affects and Fix fields

    • getVersionById

      VersionService.VersionResult getVersionById(ApplicationUser user, Project project, Long versionId)
      Used to retrieve a Version object by version id within project specified by Project object. This method returns a VersionService.VersionResult. The version will be null if no version for the id specified can be found, or if the user making the request does not have the ADMIN, PROJECT_ADMIN or BROWSE project permission for the project. In both of these cases, the errorCollection in the result object will contain an appropriate error message.
      Parameters:
      user - The user trying to get a version
      project - The project object containing requested version
      versionId - The id of requested version
      Returns:
      VersionResult object
      Since:
      6.1.1

    • getVersionById

      VersionService.VersionResult getVersionById(ApplicationUser user, Long versionId)
      Used to retrieve a Version object by version id. This method returns a VersionService.VersionResult. The version will be null if no version for the id specified can be found, or if the user making the request does not have the ADMIN, PROJECT_ADMIN or BROWSE project permission for the project. In both of these cases, the errorCollection in the result object will contain an appropriate error message.
      Parameters:
      user - The user trying to get a version
      versionId - The id of requested version
      Returns:
      VersionResult object
      Since:
      6.1.1

    • getVersionByProjectAndName

      @Nonnull VersionService.VersionResult getVersionByProjectAndName(@Nullable ApplicationUser user, @Nonnull Project project, @Nonnull String versionName)
      Used to retrieve a Version object by version name within project specified by Project object. This method returns a VersionService.VersionResult. The version will be null if no version for the versionName specified can be found, or if the user making the request does not have the ADMIN, PROJECT_ADMIN or BROWSE project permission for the project. In both of these cases, the errorCollection in the result object will contain an appropriate error message.
      Parameters:
      user - The user trying to get a version
      project - The project object containing requested version
      versionName - The name of requested version
      Returns:
      VersionResult containing errors and the Version if it could be found
      Since:
      v6.4

    • getVersionsByProject

      @Nonnull VersionService.VersionsResult getVersionsByProject(@Nullable ApplicationUser user, @Nonnull Project project)
      Used to retrieve a Version collection within project specified by Project object. This method returns a VersionService.VersionsResult. The versions collection will be empty if the user making the request does not have the ADMIN, PROJECT_ADMIN or BROWSE project permission for the project. In this case, the errorCollection in the result object will contain an appropriate error message.
      Parameters:
      user - The user trying to get a version
      project - The project object containing requested version
      Returns:
      VerionsResult object
      Since:
      v6.4

    • getVersionsByProject

      @Nonnull ServiceOutcome<Page<Version>> getVersionsByProject(@Nullable ApplicationUser user, @Nonnull Project project, @Nonnull PageRequest pageRequest)
      This method returns all versions for a given project. It's similar to the getVersionsByProject(ApplicationUser, Project) but the results it returns are paged.

      The user making the request must have the ADMIN, PROJECT_ADMIN or BROWSE project permissions for the project. Otherwise, the errorCollection in the result object will contain an appropriate error message.

      Parameters:
      user - The user trying to get a version
      project - The project object containing requested version
      pageRequest - details of a page to return (offset, max number of results)
      Returns:
      A single page of versions or an appropriate error message if the user does not have permissions to read versions for the project
      Since:
      v6.4
      See Also:

    • getVersionsByProject

      @Nonnull ServiceOutcome<Page<Version>> getVersionsByProject(@Nullable ApplicationUser user, @Nonnull Project project, @Nonnull PageRequest pageRequest, @Nullable OrderByRequest<VersionService.VersionExtractableField> orderBy)
      This method returns all versions for a given project. It's similar to the VersionService#getVersionsByProject(ApplicationUser, Project) but the results it returns are paged.

      It also provides the possibility to sort the results by the fields specified in the VersionService.VersionExtractableField class.

      The user making the request must have the ADMIN, PROJECT_ADMIN or BROWSE project permissions for the project. Otherwise, the errorCollection in the result object will contain an appropriate error message.

      Parameters:
      user - The user trying to get a version
      project - The project object containing requested version
      pageRequest - details of a page to return (offset, max number of results)
      orderBy - details on how to order the results
      Returns:
      A single page of versions or an appropriate error message if the user does not have permissions to read versions for the project
      Since:
      v6.4
      See Also:

    • findVersions

      @Nonnull @ExperimentalApi Stream<Version> findVersions(@Nullable ApplicationUser user, @Nonnull String substring)
      Returns all versions visible by the given user filtered by given query.
      Parameters:
      user - user trying to find the versions
      substring - optional query used to filter returned versions
      Since:
      v9.2

    • findVersionsByProjects

      @Nonnull @ExperimentalApi Stream<Version> findVersionsByProjects(@Nullable ApplicationUser user, @Nonnull String substring, @NotEmpty @NotEmpty Set<Long> projectIds)
      Returns all versions visible by the given user filtered by given query and available in given projects.
      Parameters:
      user - user trying to find the versions
      substring - optional query used to filter returned versions
      projectIds - set of project IDs to filter versions with
      Since:
      v9.2

    • validateCreateVersion

      @Deprecated VersionService.CreateVersionValidationResult validateCreateVersion(ApplicationUser user, Project project, String versionName, String releaseDate, String description, Long scheduleAfterVersion)
      Deprecated.
      Use validateCreate(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilder) and create(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilderValidationResult). Since v6.4.
      This method needs to be called before creating a version to ensure all parameters are correct. There are a number of required parameters, such as a project object and versionName. An error will be returned if the user making the request does not have the ADMIN or PROJECT_ADMIN permission for the project. The validation will also check if a version with the name provided already exists and throw an appropriate error.

      Optional validation will be done for the release date, if provided. An error will be returned, if date format is valid.

      The method will return a VersionService.CreateVersionValidationResult which contains an ErrorCollection with any potential errors and all the version's details.

      Parameters:
      user - The user trying to create a version
      project - The project object containing requested version
      versionName - The name of created version
      releaseDate - The release date for a version (optional)
      description - The description for a version (optional)
      scheduleAfterVersion - The version after which created version should be scheduled (optional)
      Returns:
      CreateVersionValidationResult object

    • validateCreateVersion

      @Deprecated VersionService.CreateVersionValidationResult validateCreateVersion(ApplicationUser user, Project project, String versionName, Date releaseDate, String description, Long scheduleAfterVersion)
      Deprecated.
      Use validateCreate(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilder) and create(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilderValidationResult). Since v6.4
      This method needs to be called before creating a version to ensure all parameters are correct. There are a number of required parameters, such as a project object and versionName. An error will be returned if the user making the request does not have the ADMIN or PROJECT_ADMIN permission for the project. The validation will also check if a version with the name provided already exists and throw an appropriate error.

      Optional validation will be done for the release date, if provided. An error will be returned, if date format is valid.

      The method will return a VersionService.CreateVersionValidationResult which contains an ErrorCollection with any potential errors and all the version's details.

      Parameters:
      user - The user trying to create a version
      project - The project object containing requested version
      versionName - The name of created version
      releaseDate - The release date for a version (optional)
      description - The description for a version (optional)
      scheduleAfterVersion - The version after which created version should be scheduled (optional)
      Returns:
      CreateVersionValidationResult object

    • createVersion

      @Deprecated Version createVersion(ApplicationUser user, VersionService.CreateVersionValidationResult request)
      Deprecated.
      Use validateCreate(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilder) and create(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.version.VersionService.VersionBuilderValidationResult). Since v6.4
      Using the validation result from
      invalid reference 
      #validateCreateVersion(User, com.atlassian.jira.project.Project, String, String, String, Long)
      a new version will be created. This method will throw an RuntimeException if the version could not be created.
      Parameters:
      user - The user trying to get a version
      request - The VersionService.CreateVersionValidationResult object containing all required data
      Returns:
      created Version object

    • validateReleaseVersion

      @Nonnull VersionService.ReleaseVersionValidationResult validateReleaseVersion(@Nullable ApplicationUser user, @Nonnull Version version, @Nullable Date releaseDate)
      This method needs to be called before releasing a version to ensure all parameters are correct. There is required parameter, version object. An error will be returned if the user making the request does not have the ADMIN or PROJECT_ADMIN permission for the project. The validation will also check if a version provided has a valid name and if is not released already.

      The method will return a VersionService.ReleaseVersionValidationResult which contains an ErrorCollection with any potential errors and all the version's details.

      Parameters:
      user - The user trying to release a version
      version - The version to release
      releaseDate - The version release date (optional)
      Returns:
      ReleaseVersionValidationResult object
      Since:
      v6.4.

    • validateReleaseVersion

      @Nonnull VersionService.ReleaseVersionValidationResult validateReleaseVersion(@Nullable ApplicationUser user, @Nonnull Version version, @Nonnull String releaseDate)
      This method needs to be called before releasing a version to ensure all parameters are correct. There is required parameter, version object. An error will be returned if the user making the request does not have the ADMIN or PROJECT_ADMIN permission for the project. The validation will also check if a version provided has a valid name and if is not released already.

      The method will return a VersionService.ReleaseVersionValidationResult which contains an ErrorCollection with any potential errors and all the version's details.

      Parameters:
      user - The user trying to release a version
      version - The version to release
      releaseDate - The version release date (optional)
      Returns:
      ReleaseVersionValidationResult object
      Since:
      v6.4

    • validateUnreleaseVersion

      @Nonnull VersionService.ReleaseVersionValidationResult validateUnreleaseVersion(@Nullable ApplicationUser user, @Nonnull Version version, @Nullable Date releaseDate)
      This method needs to be called before unreleasing a version to ensure all parameters are correct. There is required parameter, version object. An error will be returned if the user making the request does not have the ADMIN or PROJECT_ADMIN permission for the project. The validation will also check if a version provided has a valid name and if is released already.

      The method will return a VersionService.ReleaseVersionValidationResult which contains an ErrorCollection with any potential errors and all the version's details.

      Parameters:
      user - The user trying to unrelease a version
      version - The version to release
      releaseDate - The version release date (optional)
      Returns:
      ReleaseVersionValidationResult object
      Since:
      v6.4

    • validateUnreleaseVersion

      @Nonnull VersionService.ReleaseVersionValidationResult validateUnreleaseVersion(@Nullable ApplicationUser user, @Nonnull Version version, @Nonnull String releaseDate)
      This method needs to be called before unreleasing a version to ensure all parameters are correct. There is required parameter, version object. An error will be returned if the user making the request does not have the ADMIN or PROJECT_ADMIN permission for the project. The validation will also check if a version provided has a valid name and if is released already.

      The method will return a VersionService.ReleaseVersionValidationResult which contains an ErrorCollection with any potential errors and all the version's details.

      Parameters:
      user - The user trying to unrelease a version
      version - The version to release
      releaseDate - The version release date (optional)
      Returns:
      ReleaseVersionValidationResult object
      Since:
      v6.4

    • releaseVersion

      Version releaseVersion(VersionService.ReleaseVersionValidationResult result)
      Using the validation result from
      invalid reference 
      #validateReleaseVersion(User, com.atlassian.jira.project.version.Version, Date)
      a version will be released. This method will throw an IllegalArgumentException if the provied data are invalid and version could not be released.
      Parameters:
      result - a ReleaseVersionValidationResult containg required data
      Returns:
      a released version object

    • moveUnreleasedToNewVersion

      void moveUnreleasedToNewVersion(@Nullable ApplicationUser user, @Nonnull Version currentVersion, @Nonnull Version newVersion)
      Using the validation result from
      invalid reference 
      #validateReleaseVersion(User, com.atlassian.jira.project.version.Version, Date)
      a version will be released. This method will throw an IllegalArgumentException if the provided data are invalid and version could not be released.
      Parameters:
      user - The user trying to release a version
      currentVersion - The current version being released.
      newVersion - The version to move issues to.
      Since:
      v6.4

    • unreleaseVersion

      Version unreleaseVersion(VersionService.ReleaseVersionValidationResult result)
      Using the validation result from
      invalid reference 
      #validateUnreleaseVersion(User, com.atlassian.jira.project.version.Version, Date)
      a version will be unreleased. This method will throw an IllegalArgumentException if the provied data are invalid and version could not be unreleased.
      Parameters:
      result - a ReleaseVersionValidationResult containg required data
      Returns:
      a unreleased version object

    • validateArchiveVersion

      @Nonnull VersionService.ArchiveVersionValidationResult validateArchiveVersion(@Nullable ApplicationUser user, @Nonnull Version version)
      This method should be called before archiving a version. It performs some basic validation of the version that was passed in. This includes a null check, checking that the version name isn't empty, and checking that the version is linked against a valid project.

      The method also validates that the user passed in is either a global admin, or has project admin rights for the project that the version is linked to.

      Finally, this method checks that the version that was passed in hasn't already been archived. If there's any errors, the validationResult will contain appropriate errors and wont be valid.

      Parameters:
      user - The user performing this operation
      version - The version to be archived
      Returns:
      a validation result, containing any errors or the version details on success
      Since:
      v6.4

    • validateUnarchiveVersion

      @Nonnull VersionService.ArchiveVersionValidationResult validateUnarchiveVersion(@Nullable ApplicationUser user, @Nonnull Version version)
      This method should be called before unarchiving a version. It performs some basic validation of the version that was passed in. This includes a null check, checking that the version name isn't empty, and checking that the version is linked against a valid project.

      The method also validates that the user passed in is either a global admin, or has project admin rights for the project that the version is linked to.

      Finally, this method checks that the version that was passed is currently archived. If there's any errors, the validationResult will contain appropriate errors and wont be valid.

      Parameters:
      user - The user performing this operation
      version - The version to be archived
      Returns:
      a validation result, containing any errors or the version details on success
      Since:
      v6.4

    • archiveVersion

      Version archiveVersion(VersionService.ArchiveVersionValidationResult result)
      Takes a validation result and performs the archive operation.
      Parameters:
      result - The result from the validation
      Returns:
      The version that was archived. Ideally this version should have been retrieved from the store for consistency
      Throws:
      IllegalStateException - if the result passed in is not valid.

    • unarchiveVersion

      Version unarchiveVersion(VersionService.ArchiveVersionValidationResult result)
      Takes a validation result and performs the unarchive operation.
      Parameters:
      result - The result from the validation
      Returns:
      The version that was unarchived. Ideally this version should have been retrieved from the store for consistency
      Throws:
      IllegalStateException - if the result passed in is not valid.

    • isOverdue

      boolean isOverdue(Version version)
      Is the passed version overdue? This method does no permission checks on the passed version.
      Parameters:
      version - the version to check.
      Returns:
      true if the passed version is overdue.

    • validateMoveToStartVersionSequence

      @Nonnull VersionService.MoveVersionValidationResult validateMoveToStartVersionSequence(@Nullable ApplicationUser user, long versionId)
      Validate Move a version to the start of the version list.
      Parameters:
      user - The user trying to move a version
      Returns:
      a validation result, containing any errors or the version details on success
      Since:
      v6.4

    • validateIncreaseVersionSequence

      @Nonnull VersionService.MoveVersionValidationResult validateIncreaseVersionSequence(@Nullable ApplicationUser user, long versionId)
      Validate Move a version to have a lower sequence number - ie make it earlier.
      Parameters:
      user - The user trying to move a version
      Returns:
      a validation result, containing any errors or the version details on success
      Since:
      v6.4

    • validateDecreaseVersionSequence

      @Nonnull VersionService.MoveVersionValidationResult validateDecreaseVersionSequence(@Nullable ApplicationUser user, long versionId)
      Validate Move a version to have a higher sequence number - ie make it later.
      Parameters:
      user - The user trying to move a version
      Returns:
      a validation result, containing any errors or the version details on success
      Since:
      v6.4

    • validateMoveToEndVersionSequence

      @Nonnull VersionService.MoveVersionValidationResult validateMoveToEndVersionSequence(@Nullable ApplicationUser user, long versionId)
      Validate Move a version to the end of the version sequence.
      Parameters:
      user - The user trying to move a version
      Returns:
      a validation result, containing any errors or the version details on success
      Since:
      v6.4

    • validateMoveVersionAfter

      VersionService.MoveVersionValidationResult validateMoveVersionAfter(@Nullable ApplicationUser user, long versionId, @Nonnull Long scheduleAfterVersion)
      Validate Move a version after another version.
      Parameters:
      user - The user trying to move a version
      versionId - version to reschedule
      scheduleAfterVersion - id of the version to schedule after the given version object
      Returns:
      a validation result, containing any errors or the version details and schedule after target on success
      Since:
      v6.4

    • moveToStartVersionSequence

      void moveToStartVersionSequence(VersionService.MoveVersionValidationResult moveVersionValidationResult)
      Move a version to the start of the version list.
      Parameters:
      moveVersionValidationResult - Move Version Validation Result

    • increaseVersionSequence

      void increaseVersionSequence(VersionService.MoveVersionValidationResult moveVersionValidationResult)
      Move a version to have a lower sequence number - ie make it earlier.
      Parameters:
      moveVersionValidationResult - Move Version Validation Result

    • decreaseVersionSequence

      void decreaseVersionSequence(VersionService.MoveVersionValidationResult moveVersionValidationResult)
      Move a version to have a higher sequence number - ie make it later.
      Parameters:
      moveVersionValidationResult - Move Version Validation Result

    • moveToEndVersionSequence

      void moveToEndVersionSequence(VersionService.MoveVersionValidationResult moveVersionValidationResult)
      Move a version to the end of the version sequence.
      Parameters:
      moveVersionValidationResult - Move Version Validation Result

    • moveVersionAfter

      void moveVersionAfter(VersionService.MoveVersionValidationResult moveVersionValidationResult)
      Move a version after another version.
      Parameters:
      moveVersionValidationResult - Move Version Validation Result

    • getFixIssuesCount

      long getFixIssuesCount(Version version)
      Return the count of Issues Fixed in this version.
      Returns:
      A count of issues

    • getAffectsIssuesCount

      long getAffectsIssuesCount(Version version)
      Return the count of Issues that have the "Affects Version" field set to version.
      Returns:
      A count of issues

    • getCustomFieldsUsing

      @Nonnull Collection<CustomFieldWithVersionUsage> getCustomFieldsUsing(@Nonnull Version version)
      This method returns usage information in custom fields for a given version.
      Parameters:
      version - The version that we want to get information about.
      Returns:
      collection of version usage for each custom fields.

    • getCustomFieldIssuesCount

      long getCustomFieldIssuesCount(@Nonnull Version version)
      This method returns the total number of issues where this version is used in custom fields
      Parameters:
      version - The version that we want to get information about.
      Returns:
      collection of version usage for each custom fields.
      Since:
      7.0.10

    • getUnresolvedIssuesCount

      long getUnresolvedIssuesCount(@Nullable ApplicationUser user, @Nonnull Version version)
      Return the count of Issues that are unresolved in this version. Used when releasing a version to get user confirmation about what to do with the unresolved issues.
      Parameters:
      user - the user trying to get the count
      version - which version to check for unresolved issues
      Returns:
      A count of issues
      Since:
      v6.4

    • createVersionDeletaAndReplaceParameters

      DeleteVersionWithReplacementsParameterBuilder createVersionDeletaAndReplaceParameters(@Nonnull Version versionToDelete)
      Create builder that for paramaters to remove version with swap (including custom fields)
      Parameters:
      versionToDelete - version that will be deleted - mandatory
      Since:
      7.0.10
      See Also:

    • deleteVersionAndSwap

      ServiceResult deleteVersionAndSwap(@Nonnull JiraServiceContext serviceContext, @Nonnull DeleteVersionWithCustomFieldParameters parameters)
      Remove specified version. According to information in DeleteVersionWithCustomFieldParameters version will be completly removed from specific fields are replaced.
      Parameters:
      serviceContext - The context for this service call.
      parameters - parameters build with builder obtained by createVersionDeletaAndReplaceParameters(Version)
      Returns:
      result than holds eventual errors in removal
      Since:
      7.0.10
      See Also:

    • newVersionBuilder

      VersionBuilder newVersionBuilder()
      Creates a builder to be used when creating a new Version. The builder encapsulates all the fields which need to be specified on create.
      Returns:
      the builder instance
      Since:
      v6.0
      See Also:

    • newVersionBuilder

      VersionBuilder newVersionBuilder(Version version)
      Creates a builder to be used when updating an existing Version. The builder encapsulates all the fields which need to be specified on update.
      Parameters:
      version - the Version object to update
      Returns:
      the builder instance
      Since:
      v6.0
      See Also:

    • validateCreate

      @Nonnull VersionService.VersionBuilderValidationResult validateCreate(@Nullable ApplicationUser user, @Nonnull VersionBuilder versionBuilder)
      Validates the creation of a new Version object, specified with a VersionBuilder.

      This replaces the deprecated methods:

      invalid reference 
      #validateCreateVersion(User, Project, String, Date, String, Long)
      and
      invalid reference 
      #validateCreateVersion(User, Project, String, String, String, Long)
      .
      Parameters:
      user - the user who is performing the create
      versionBuilder - the builder which specified the new Version to be created
      Returns:
      the result
      Since:
      v7.0
      See Also:

    • create

      @Nonnull ServiceOutcome<Version> create(@Nullable ApplicationUser user, @Nonnull VersionService.VersionBuilderValidationResult validationResult)
      Creates a new Version, based on the validation result from calling
      invalid reference 
      #validateCreate(User, VersionBuilder)
      .
      Parameters:
      user - the user
      validationResult - the result of validation
      Returns:
      the new Version object; errors if not successful.
      Since:
      v6.4
      See Also:
      • invalid reference 
        #validateCreate(com.atlassian.crowd.embedded.api.User, VersionBuilder)
      • invalid reference 
        #validateCreate(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.bc.project.version.VersionService.VersionBuilder)

    • validateUpdate

      @Nonnull VersionService.VersionBuilderValidationResult validateUpdate(@Nullable ApplicationUser user, @Nonnull VersionBuilder versionBuilder)
      Validates the update of an existing Version object, specified with a VersionBuilder.
      Parameters:
      user - the user who is performing the update
      versionBuilder - the builder which specified the update to the existing Version
      Returns:
      the result
      Since:
      v6.4
      See Also:

    • update

      ServiceOutcome<Version> update(ApplicationUser user, VersionService.VersionBuilderValidationResult validationResult)
      Updates the existing Version, based on the validation result from calling
      invalid reference 
      #validateUpdate(User, VersionBuilder)
      .
      Parameters:
      user - the user
      validationResult - the result of validation
      Returns:
      the updated Version object; errors if not successful.
      Since:
      v6.4
      See Also:
      • invalid reference 
        #validateUpdate(com.atlassian.crowd.embedded.api.User, VersionBuilder)
      • invalid reference 
        #validateUpdate(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.bc.project.version.VersionService.VersionBuilder)