Package com.atlassian.jira.i18n.terminology

Class TerminologyEntryWriterImpl

java.lang.Object

com.atlassian.jira.i18n.terminology.TerminologyEntryWriterImpl

All Implemented Interfaces:

TerminologyEntryWriter

@ParametersAreNonnullByDefault
public class TerminologyEntryWriterImpl
extends Object
implements TerminologyEntryWriter

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.i18n.terminology.TerminologyEntryWriter

TerminologyEntryWriter.TerminologyValidationResult

Constructor Summary

Constructors

Constructor

Description

TerminologyEntryWriterImpl(TerminologyEntryReader terminologyEntryReader, TerminologyEntryDao terminologyEntryDao, GlobalPermissionManager permissionManager, JiraAuthenticationContext jiraAuthenticationContext, TerminologyEntryValidator terminologyEntryValidator, com.atlassian.event.api.EventPublisher eventPublisher, FeatureManager featureManager, DataCenterOrDevModeCheck dataCenterOrDevModeCheck)

Method Summary

Modifier and Type	Method	Description
void	changeTerminology(TerminologyEntryWriter.TerminologyValidationResult terminologyValidationResults)	Update terminology with new name mapping.
TerminologyEntryWriter.TerminologyValidationResult	validateAndPrepareTerminologyChange(Collection<TerminologyEntry> terminologyEntries)	Validate whether a new terminology entry can be created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TerminologyEntryWriterImpl

public TerminologyEntryWriterImpl(TerminologyEntryReader terminologyEntryReader,
 TerminologyEntryDao terminologyEntryDao,
 GlobalPermissionManager permissionManager,
 JiraAuthenticationContext jiraAuthenticationContext,
 TerminologyEntryValidator terminologyEntryValidator,
 com.atlassian.event.api.EventPublisher eventPublisher,
 FeatureManager featureManager,
 DataCenterOrDevModeCheck dataCenterOrDevModeCheck)

Method Details

validateAndPrepareTerminologyChange

public TerminologyEntryWriter.TerminologyValidationResult validateAndPrepareTerminologyChange(Collection<TerminologyEntry> terminologyEntries)

Description copied from interface: TerminologyEntryWriter

Validate whether a new terminology entry can be created. Provide data that can be used to create it. The TerminologyEntryWriter.changeTerminology(com.atlassian.jira.i18n.terminology.TerminologyEntryWriter.TerminologyValidationResult) method should only be called if ServiceResultImpl.isValid() is true. Provided names are changed to lowercase and trimmed from whitespaces.

Firstly permissions are checked. If a user has no rights to create terminology entry a general error with ErrorCollection.Reason.FORBIDDEN is returned.

Secondly, provided data is validated. All found errors are returned, their fields (see ErrorCollection) are set to originalName, newName or newNamePlural depending on which field is affected.

Usage example: final TerminologyValidationResult result = terminologyEntryWriter.validateAndPrepareTerminologyChange(terminologyEntryList); if (result.isValid()) { terminologyEntryWriter.changeTerminology(result); }

Specified by:

validateAndPrepareTerminologyChange in interface TerminologyEntryWriter

Parameters:

terminologyEntries - a collection of TerminologyEntry to be validated

Returns:

The result that will contain TerminologyEntry if validation was successful or errors otherwise.

changeTerminology

public void changeTerminology(TerminologyEntryWriter.TerminologyValidationResult terminologyValidationResults)

Description copied from interface: TerminologyEntryWriter

Update terminology with new name mapping. All occurrences of original name (see TerminologyEntry.getOriginalName()) will be visible as new name (see TerminologyEntry.getNewName() and TerminologyEntry.getNewNamePlural()).

Names that are possible to be changed are defined in 'sprint' or 'epic'.

If you would like to get back to default name for the entry, you need to provide a TerminologyEntry with TerminologyEntry.getNewName() equal to TerminologyEntry.getOriginalName().

Specified by:

changeTerminology in interface TerminologyEntryWriter

Parameters:

terminologyValidationResults - contains the entry to store. This must be taken from TerminologyEntryWriter.validateAndPrepareTerminologyChange(java.util.Collection<com.atlassian.jira.i18n.terminology.TerminologyEntry>). Its ServiceResultImpl.isValid() must return true, otherwise this method will throw IllegalStateException.