com.atlassian.jira.issue.fields

Class AbstractVersionsSystemField

java.lang.Object

com.atlassian.jira.issue.fields.AbstractField

com.atlassian.jira.issue.fields.AbstractOrderableField<V>

com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl<Collection<Version>>

com.atlassian.jira.issue.fields.AbstractVersionsSystemField

All Implemented Interfaces:

ExportableSystemField, Field, HideableField, NavigableField, OrderableField<Collection<Version>>, RequirableField, RestAwareField, SearchableField, Comparable

Direct Known Subclasses:

AffectedVersionsSystemField, FixVersionsSystemField

public abstract class AbstractVersionsSystemField
extends AbstractOrderableNavigableFieldImpl<Collection<Version>>
implements HideableField, RequirableField, RestAwareField, ExportableSystemField

Copyright (c) 2002-2004 All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static Long	RELEASED_VERSION_ID
protected SearchLinkGenerator	searchLinkGenerator
static Long	UNKNOWN_VERSION_ID
static Long	UNRELEASED_VERSION_ID
protected VersionHelperBean	versionHelperBean
protected VersionManager	versionManager

Fields inherited from class com.atlassian.jira.issue.fields.AbstractField

authenticationContext

Fields inherited from interface com.atlassian.jira.issue.fields.NavigableField

ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH

Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField

MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH

Constructor Summary

Constructors

Constructor and Description

AbstractVersionsSystemField(String id, String name, VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, VersionManager versionManager, PermissionManager permissionManager, JiraAuthenticationContext authenticationContext, VersionHelperBean versionHelperBean, SearchHandlerFactory searchHandlerFactory, SearchLinkGenerator searchLinkGenerator, JiraBaseUrls jiraBaseUrls, JqlStringSupport jqlStringSupport)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addFieldRequiredErrorMessage(Issue issue, ErrorCollection errorCollectionToAddTo, I18nHelper i18n)
protected Map<String,Object>	addViewVelocityParams()
String	availableForBulkEdit(BulkEditBean bulkEditBean) Determines whether the field is available for bulk editing given the BulkEditBean.
void	createValue(Issue issue, Collection<Version> value) Create the value of the issue in the data store.
protected abstract String	getArchivedVersionsFieldTitle()
String	getBulkEditHtml(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters) Returns HTML that should be shown when a version field is being bulk edited.
protected abstract String	getChangeItemFieldName()
String	getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
String	getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns the HTML that should be shown when the issue is being created.
protected LongIdsValueHolder	getCurrentVersionIds(Issue issue)
protected abstract Collection<Version>	getCurrentVersions(Issue issue)
String	getDefaultSortOrder() The order in which to sort the field when it is sorted for the first time.
Collection<Version>	getDefaultValue(Issue issue) The value that should be set on the issue if the field is not shown for some reason.
String	getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns HTML that should be shown when the issue is being edited.
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.
protected abstract String	getIssueRelationName()
FieldJsonRepresentation	getJsonFromIssue(Issue issue, boolean renderedVersionRequired, FieldLayoutItem fieldLayoutItem) Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.
JsonType	getJsonSchema() Return a description of the shape of this field when represented as JSON.
protected abstract String	getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)
protected List<VersionProxy>	getPossibleVersions(Project project, boolean unreleasedFirst)
protected Object	getRelevantParams(Map<String,String[]> params)
FieldExportParts	getRepresentationFromIssue(Issue issue) For the given issue get an exportable representation for the field
protected abstract boolean	getUnreleasedVersionsFirst()
Collection<Version>	getValueFromParams(Map params) Get a field value from the map of parameters passed.
protected VersionManager	getVersionManager()
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Collection<Version> value, Map displayParameters)
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
boolean	hasValue(Issue issue) Determines if the field has a value for the given issue.
MessagedResult	needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem) Used to determine if the field needs input from user to be moved to the new project and/or issue type.
void	populateDefaults(Map<String,Object> fieldValuesHolder, Issue issue) Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.
void	populateForMove(Map<String,Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue) Used to populate the fieldValueHolder with parameters for move issue screen.
void	populateFromIssue(Map<String,Object> params, Issue issue) Used to initialise the fieldValuesHolder from the current value of teh issue.
void	populateParamsFromString(Map<String,Object> fieldValuesHolder, String stringValue, Issue issue) Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
protected abstract JqlClauseBuilder	queryArchivedVersionsField(JqlClauseBuilder and, Version name)
protected abstract List<ChangeItemBean>	updateIssueValue(Issue issue, Collection<Version> newValue)
void	updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) Update the issue in the data store.
void	validateParams(OperationContext operationContext, ErrorCollection errorCollection, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Ensure that the parameters are valid

Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl

getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getSortFields, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory

Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField

createAssociatedSearchHandler, getApplicationProperties, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, validateBulkEditHtmlProperties, valuesEqual

Methods inherited from class com.atlassian.jira.issue.fields.AbstractField

compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.fields.Field

getId, getName, getNameKey

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.atlassian.jira.issue.fields.NavigableField

getColumnHeadingKey, getSorter, prettyPrintChangeHistory

Methods inherited from interface com.atlassian.jira.issue.fields.OrderableField

canRemoveValueFromIssueObject, isShown, removeValueFromIssueObject, updateIssue

Field Detail

UNKNOWN_VERSION_ID

public static final Long UNKNOWN_VERSION_ID

UNRELEASED_VERSION_ID

public static final Long UNRELEASED_VERSION_ID

RELEASED_VERSION_ID

public static final Long RELEASED_VERSION_ID

versionManager

protected final VersionManager versionManager

versionHelperBean

protected final VersionHelperBean versionHelperBean

searchLinkGenerator

protected final SearchLinkGenerator searchLinkGenerator

Constructor Detail

AbstractVersionsSystemField

public AbstractVersionsSystemField(String id,
                                   String name,
                                   VelocityTemplatingEngine templatingEngine,
                                   ApplicationProperties applicationProperties,
                                   VersionManager versionManager,
                                   PermissionManager permissionManager,
                                   JiraAuthenticationContext authenticationContext,
                                   VersionHelperBean versionHelperBean,
                                   SearchHandlerFactory searchHandlerFactory,
                                   SearchLinkGenerator searchLinkGenerator,
                                   JiraBaseUrls jiraBaseUrls,
                                   JqlStringSupport jqlStringSupport)

Method Detail

getCreateHtml

public String getCreateHtml(FieldLayoutItem fieldLayoutItem,
                            OperationContext operationContext,
                            webwork.action.Action action,
                            Issue issue,
                            Map displayParameters)

Description copied from interface: OrderableField

Returns the HTML that should be shown when the issue is being created.

Specified by:

getCreateHtml in interface OrderableField<Collection<Version>>

Parameters:

fieldLayoutItem - FieldLayoutItem

operationContext - OperationContext

action - Action

issue - Issue

displayParameters - Map of display parameters.

Returns:

the HTML that should be shown when the issue is being created.

getEditHtml

public String getEditHtml(FieldLayoutItem fieldLayoutItem,
                          OperationContext operationContext,
                          webwork.action.Action action,
                          Issue issue,
                          Map displayParameters)

Description copied from interface: OrderableField

Returns HTML that should be shown when the issue is being edited.

Specified by:

getEditHtml in interface OrderableField<Collection<Version>>

Parameters:

fieldLayoutItem - FieldLayoutItem

operationContext - OperationContext

action - Action

issue - Issue

displayParameters - Map of display parameters.

Returns:

HTML that should be shown when the issue is being edited.

getBulkEditHtml

public String getBulkEditHtml(OperationContext operationContext,
                              webwork.action.Action action,
                              BulkEditBean bulkEditBean,
                              Map displayParameters)

Returns HTML that should be shown when a version field is being bulk edited.

The HTML displayed for Bulk Move of Versions needs to allow the user to specify mappings for each old version present in the currently selected issues.

Specified by:

getBulkEditHtml in interface OrderableField<Collection<Version>>

Overrides:

getBulkEditHtml in class AbstractOrderableField<Collection<Version>>

Parameters:

operationContext - OperationContext

action - Action

bulkEditBean - BulkEditBean

displayParameters - Map of display parameters.

Returns:

HTML that should be shown when the issue is being edited.

getViewHtml

public String getViewHtml(FieldLayoutItem fieldLayoutItem,
                          webwork.action.Action action,
                          Issue issue,
                          Map displayParameters)

Specified by:

getViewHtml in interface OrderableField<Collection<Version>>

getViewHtml

public String getViewHtml(FieldLayoutItem fieldLayoutItem,
                          webwork.action.Action action,
                          Issue issue,
                          Collection<Version> value,
                          Map displayParameters)

Specified by:

getViewHtml in interface OrderableField<Collection<Version>>

addViewVelocityParams

protected Map<String,Object> addViewVelocityParams()

getRelevantParams

protected Object getRelevantParams(Map<String,String[]> params)

Specified by:

getRelevantParams in class AbstractOrderableField<Collection<Version>>

getValueFromParams

public Collection<Version> getValueFromParams(Map params)

Description copied from interface: OrderableField

Get a field value from the map of parameters passed. The params map may contain other parameters that are not relevant to this custom field.

Specified by:

getValueFromParams in interface OrderableField<Collection<Version>>

Parameters:

params - the map of parameters.

Returns:

Value for this field from the map of parameters.

populateParamsFromString

public void populateParamsFromString(Map<String,Object> fieldValuesHolder,
                                     String stringValue,
                                     Issue issue)
                              throws FieldValidationException

Description copied from interface: OrderableField

Used to convert from a user friendly string value and put the result into the fieldValuesHolder. This method is useful for places like Jelly where the field value can be a name (e.g. issue type name) and not a regular id that is used in the web pages.

Specified by:

populateParamsFromString in interface OrderableField<Collection<Version>>

Parameters:

fieldValuesHolder - Map of field Values.

stringValue - user friendly string value

issue - the Issue

Throws:

FieldValidationException - if cannot convert to a value from the given string

populateFromIssue

public void populateFromIssue(Map<String,Object> params,
                              Issue issue)

Description copied from interface: OrderableField

Used to initialise the fieldValuesHolder from the current value of teh issue. Used, for example, when showing the Edit Issue screen to show the issue's current values.

Specified by:

populateFromIssue in interface OrderableField<Collection<Version>>

Parameters:

params - The fieldValuesHolder Map to be populated.

issue - The Issue.

getCurrentVersionIds

protected LongIdsValueHolder getCurrentVersionIds(Issue issue)

getCurrentVersions

protected abstract Collection<Version> getCurrentVersions(Issue issue)

getArchivedVersionsFieldTitle

protected abstract String getArchivedVersionsFieldTitle()

queryArchivedVersionsField

protected abstract JqlClauseBuilder queryArchivedVersionsField(JqlClauseBuilder and,
                                                               Version name)

getUnreleasedVersionsFirst

protected abstract boolean getUnreleasedVersionsFirst()

getPossibleVersions

protected List<VersionProxy> getPossibleVersions(Project project,
                                                 boolean unreleasedFirst)

validateParams

public void validateParams(OperationContext operationContext,
                           ErrorCollection errorCollection,
                           I18nHelper i18n,
                           Issue issue,
                           FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)

Description copied from interface: OrderableField

Ensure that the parameters are valid

Specified by:

validateParams in interface OrderableField<Collection<Version>>

Parameters:

operationContext - OperationContext

errorCollection - ErrorCollection to add to.

i18n - I18nHelper

issue - This is passed to get the value of other fields that may or may not have been modified.

fieldScreenRenderLayoutItem - FieldScreenRenderLayoutItem

addFieldRequiredErrorMessage

protected abstract void addFieldRequiredErrorMessage(Issue issue,
                                                     ErrorCollection errorCollectionToAddTo,
                                                     I18nHelper i18n)

getModifiedWithoutPermissionErrorMessage

protected abstract String getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)

updateValue

public void updateValue(FieldLayoutItem fieldLayoutItem,
                        Issue issue,
                        ModifiedValue modifiedValue,
                        IssueChangeHolder issueChangeHolder)

Description copied from interface: OrderableField

Update the issue in the data store.

Fields that are simply stored in the JIRAISSUE DB table, need not do anything here as this table is written to one time to include all fields that changed. Fields using other DB tables must update that table with the appropriate values.

Specified by:

updateValue in interface OrderableField<Collection<Version>>

Parameters:

fieldLayoutItem - for this field within this context

issue - Issue this field is part of

modifiedValue - new value to set field to. Cannot be null.

issueChangeHolder - an object to record any changes made to the issue by this method.

needsMove

public MessagedResult needsMove(Collection originalIssues,
                                Issue targetIssue,
                                FieldLayoutItem targetFieldLayoutItem)

Description copied from interface: OrderableField

Used to determine if the field needs input from user to be moved to the new project and/or issue type. This method is called only if the field is visible in the target project/issue type.

Specified by:

needsMove in interface OrderableField<Collection<Version>>

Parameters:

originalIssues - Collection of original Issues.

targetIssue - Nonexistent issue object with values representing those of issue(s) after move

targetFieldLayoutItem - FieldLayoutItem

Returns:

A MessagedResult with result=true if the field needs input to be moved.

populateForMove

public void populateForMove(Map<String,Object> fieldValuesHolder,
                            Issue originalIssue,
                            Issue targetIssue)

Description copied from interface: OrderableField

Used to populate the fieldValueHolder with parameters for move issue screen. This field is only called if the issue needs to be updated during move, i.e. OrderableField.needsMove(java.util.Collection, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem) returned true, and the remote user (the one performing the move) has the permission to actually update this field.

Specified by:

populateForMove in interface OrderableField<Collection<Version>>

Parameters:

fieldValuesHolder - Map of field Values.

originalIssue - orignal Issue

targetIssue - target Issue

hasValue

public boolean hasValue(Issue issue)

Description copied from interface: OrderableField

Determines if the field has a value for the given issue.

Specified by:

hasValue in interface OrderableField<Collection<Version>>

Parameters:

issue - the Issue.

Returns:

true if the given Issue has a value for this field.

updateIssueValue

protected abstract List<ChangeItemBean> updateIssueValue(Issue issue,
                                                         Collection<Version> newValue)

createValue

public void createValue(Issue issue,
                        Collection<Version> value)

Description copied from interface: OrderableField

Create the value of the issue in the data store.

Specified by:

createValue in interface OrderableField<Collection<Version>>

Parameters:

issue - Issue this field is part of

value - Value to store in this field (eg. Collection for Version fields). Cannot be null.

populateDefaults

public void populateDefaults(Map<String,Object> fieldValuesHolder,
                             Issue issue)

Description copied from interface: OrderableField

Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.

Specified by:

populateDefaults in interface OrderableField<Collection<Version>>

Parameters:

fieldValuesHolder - The fieldValuesHolder Map to be populated.

issue - The Issue.

getDefaultValue

public Collection<Version> getDefaultValue(Issue issue)

Description copied from interface: OrderableField

The value that should be set on the issue if the field is not shown for some reason.

For example: The user does not have permission to see the field, or the field is not part of the create screen.

Specified by:

getDefaultValue in interface OrderableField<Collection<Version>>

Parameters:

issue - the Issue.

Returns:

The default value. It can be null, or an empty collection.

getChangeItemFieldName

protected abstract String getChangeItemFieldName()

getIssueRelationName

protected abstract String getIssueRelationName()

getVersionManager

protected VersionManager getVersionManager()

getDefaultSortOrder

public String getDefaultSortOrder()

Description copied from interface: NavigableField

The order in which to sort the field when it is sorted for the first time.

Specified by:

getDefaultSortOrder in interface NavigableField

Returns:

Either NavigableField.ORDER_ASCENDING or NavigableField.ORDER_DESCENDING

getColumnViewHtml

public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
                                Map displayParams,
                                Issue issue)

Specified by:

getColumnViewHtml in interface NavigableField

availableForBulkEdit

public String availableForBulkEdit(BulkEditBean bulkEditBean)

Description copied from interface: OrderableField

Determines whether the field is available for bulk editing given the BulkEditBean.

Specified by:

availableForBulkEdit in interface OrderableField<Collection<Version>>

Parameters:

bulkEditBean - holds the state of the bulk-edit wizard (e.g. the selected issues for bulk editing)

Returns:

null if the field is available for bulk-editing or an i18n key of the error message to show as why the field is not available.

getFieldTypeInfo

public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

Description copied from interface: RestAwareField

Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url

Specified by:

getFieldTypeInfo in interface RestAwareField

Parameters:

fieldTypeInfoContext - the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfo

getJsonSchema

public JsonType getJsonSchema()

Description copied from interface: RestAwareField

Return a description of the shape of this field when represented as JSON.

Specified by:

getJsonSchema in interface RestAwareField

getJsonFromIssue

public FieldJsonRepresentation getJsonFromIssue(Issue issue,
                                                boolean renderedVersionRequired,
                                                FieldLayoutItem fieldLayoutItem)

Description copied from interface: RestAwareField

Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

Specified by:

getJsonFromIssue in interface RestAwareField

Parameters:

issue - to get field data from

renderedVersionRequired - whether the use requested the return of rendered/pretty data as well as raw data

fieldLayoutItem - field layout for this field. Will only be supplied if the field is also an ordereable field.

Returns:

FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

getRepresentationFromIssue

public FieldExportParts getRepresentationFromIssue(Issue issue)

Description copied from interface: ExportableSystemField

For the given issue get an exportable representation for the field

Specified by:

getRepresentationFromIssue in interface ExportableSystemField

Parameters:

issue - to get representation for the field

Returns:

the fields exportable representation