Package com.atlassian.jira.issue.fields

Class DescriptionSystemField

java.lang.Object

com.atlassian.jira.issue.fields.AbstractField

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

com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl<String>

com.atlassian.jira.issue.fields.AbstractTextSystemField

com.atlassian.jira.issue.fields.DescriptionSystemField

All Implemented Interfaces:

ExportableSystemField, ConfigurableField<String>, DefaultValueField<String>, Field, HideableField, NavigableField, OrderableField<String>, RenderableField, RequirableField, RestAwareField, RestFieldOperations, SearchableField, Comparable

public class DescriptionSystemField
extends AbstractTextSystemField
implements HideableField, RequirableField, RestFieldOperations, DefaultValueField<String>

Represents the field which renders an Issue description.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_VALUE_TYPE

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

Description

DescriptionSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, RendererManager rendererManager, PermissionManager permissionManager, DescriptionSearchHandlerFactory searchHandlerFactory, MentionService mentionService, TextFieldCharacterLengthValidator textFieldCharacterLengthValidator, GenericConfigManager genericConfigManager, FeatureManager featureManager)

Method Summary

Modifier and Type	Method	Description
String	availableForBulkEdit(BulkEditBean bulkEditBean)	Determines whether the field is available for bulk editing given the BulkEditBean.
boolean	canRemoveValueFromIssueObject(Issue issue)	Returns true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.
List<Project>	getAssociatedProjectObjects()	Returns a list of projects associated with this field.
String	getColumnHeadingKey()
protected String	getColumnViewTemplateName()
List<FieldConfigItemType>	getConfigurationItemTypes()	Returns a List of FieldConfigItemType objects.
String	getDefaultSortOrder()	The order in which to sort the field when it is sorted for the first time.
String	getDefaultValue(Issue issue)	The value that should be set on the issue if the field is not shown for some reason.
DefaultValueOperations<String>	getDefaultValueOperations()
protected String	getEditTemplateName()
List<FieldSort>	getFieldSorts(FieldSort.Order sortOrder)	Returns a list of FieldSort objects that can be used to sort this field.
JsonData	getJsonDefaultValue(IssueContext issueCtx)	Return The default data for this system field.
FieldConfig	getRelevantConfig(IssueContext issueContext)
RestFieldOperationsHandler	getRestFieldOperation()
String	getValueFromIssue(Issue issue)	Gets the value stored for this field on the provided issue.
FieldValueLoader	getValueLoader()	A loader to be used when loading the value of the field from the index.
boolean	isShown(Issue issue)	Tests field specific way to determine if it should be shown or not.
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.
protected void	populateVelocityParams(Map fieldValuesHolder, Map params)
void	removeValueFromIssueObject(MutableIssue issue)	Removes the field value from the given MutableIssue object.
void	updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)	Record the value on the issue (not saving it to the database, see updateValue).
void	validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)	Ensure that the parameters are valid

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

createValue, getChangeLogFieldName, getChangelogValue, getColumnViewHtml, getCreateHtml, getEditHtml, getFieldTypeInfo, getJsonFromIssue, getJsonSchema, getRelevantParams, getRepresentationFromIssue, getValueFromParams, getViewHtml, getViewHtml, getViewHtml, hasValue, isInvertCollapsedState, isRenderable, needsMove, populateForMove, populateFromIssue, populateParamsFromString, populateVelocityParams, updateValue, valuesEqual

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

getColumnCssClass, getHiddenFieldId, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory

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

createAssociatedSearchHandler, getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getVelocityParams, 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 java.lang.Comparable

compareTo

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

getId, getName, getNameKey

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

hasSortsDefined, prettyPrintChangeHistory

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

createValue, getBulkEditHtml, getCreateHtml, getCreateHtml, getEditHtml, getEditHtml, getValueFromParams, getViewHtml, getViewHtml, getViewHtml, hasParam, hasValue, needsMove, populateForMove, populateFromIssue, populateFromParams, populateParamsFromString, updateValue

Methods inherited from interface com.atlassian.jira.issue.fields.renderer.RenderableField

getId

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

createAssociatedSearchHandler

Field Details

DEFAULT_VALUE_TYPE

public static final String DEFAULT_VALUE_TYPE

See Also:

• Constant Field Values

Constructor Details

DescriptionSystemField

public DescriptionSystemField(VelocityTemplatingEngine templatingEngine,
 ApplicationProperties applicationProperties,
 JiraAuthenticationContext authenticationContext,
 RendererManager rendererManager,
 PermissionManager permissionManager,
 DescriptionSearchHandlerFactory searchHandlerFactory,
 MentionService mentionService,
 TextFieldCharacterLengthValidator textFieldCharacterLengthValidator,
 GenericConfigManager genericConfigManager,
 FeatureManager featureManager)

Method Details

isShown

public boolean isShown(Issue issue)

Description copied from interface: OrderableField

Tests field specific way to determine if it should be shown or not.

Specified by:

isShown in interface OrderableField<String>

Parameters:

issue - The Issue.

Returns:

true if it should be shown.

validateParams

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

Description copied from interface: OrderableField

Ensure that the parameters are valid

Specified by:

validateParams in interface OrderableField<String>

Parameters:

operationContext - OperationContext

errorCollectionToAddTo - 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

populateVelocityParams

protected void populateVelocityParams(Map fieldValuesHolder,
 Map params)

Overrides:

populateVelocityParams in class AbstractTextSystemField

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<String>

Overrides:

populateDefaults in class AbstractTextSystemField

Parameters:

fieldValuesHolder - The fieldValuesHolder Map to be populated.

issue - The Issue.

getDefaultValue

public String 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<String>

Parameters:

issue - the Issue.

Returns:

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

getValueFromIssue

public String getValueFromIssue(Issue issue)

Description copied from interface: RenderableField

Gets the value stored for this field on the provided issue.

Specified by:

getValueFromIssue in interface RenderableField

Specified by:

getValueFromIssue in class AbstractTextSystemField

Parameters:

issue - identifies the issue that will contain the value for this field.

Returns:

the value stored on this issue for this field, null if not applicable.

updateIssue

public void updateIssue(FieldLayoutItem fieldLayoutItem,
 MutableIssue issue,
 Map fieldValueHolder)

Description copied from interface: OrderableField

Record the value on the issue (not saving it to the database, see updateValue).

Specified by:

updateIssue in interface OrderableField<String>

Parameters:

fieldLayoutItem - FieldLayoutItem

issue - MutableIssue

fieldValueHolder - Field Value Holder Map

See Also:

• OrderableField.updateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)

removeValueFromIssueObject

public void removeValueFromIssueObject(MutableIssue issue)

Description copied from interface: OrderableField

Removes the field value from the given MutableIssue object.

Note that this operation does not actually persist the change, it just clears the value from the given Issue object. The caller will still need to call #updateValue() in order to persist the change.

Some Fields may choose to quietly ignore this request. eg The SecurityLevel Field will not remove Security Level from subtasks because the subtask must always take the Security Level of its parent issue.

Specified by:

removeValueFromIssueObject in interface OrderableField<String>

Parameters:

issue - The issue object to be effected.

See Also:

• OrderableField.canRemoveValueFromIssueObject(com.atlassian.jira.issue.Issue)
• OrderableField.updateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)

canRemoveValueFromIssueObject

public boolean canRemoveValueFromIssueObject(Issue issue)

Description copied from interface: OrderableField

Returns true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.

There a few different reasons why this method may return false:

• The OrderableField can sometimes remove the value, but it decides that it is not relevant for this Issue. eg: Security Level will ignore remove requests on a subtask, as the subtask Security is not set explicitly (it is always inherited from its parent issue).
• It may possible to remove this value, but the OrderableField does not actually do the job, it is done through some special mechanism. eg Attachments.
• This field is some special system field which it is invalid to remove. eg Project. In these cases calling removeValueFromIssueObject() would normally raise an UnsupportedOperationException.

In general it is safe to call removeValueFromIssueObject() even if this method returns false, as the request will be silently ignored. However there are a couple of special fields where calling removeValueFromIssueObject() will throw an UnsupportedOperationException - eg if you try to remove the Project.

Specified by:

canRemoveValueFromIssueObject in interface OrderableField<String>

Parameters:

issue - The Issue object.

Returns:

true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.

See Also:

• OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)

getColumnHeadingKey

public String getColumnHeadingKey()

Specified by:

getColumnHeadingKey in interface NavigableField

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

getValueLoader

public FieldValueLoader getValueLoader()

Description copied from interface: NavigableField

A loader to be used when loading the value of the field from the index.

Specified by:

getValueLoader in interface NavigableField

Returns:

A loader that can be used to load the value of the field

See Also:

• DocumentIssueImpl

getFieldSorts

public List<FieldSort> getFieldSorts(FieldSort.Order sortOrder)

Description copied from interface: NavigableField

Returns a list of FieldSort objects that can be used to sort this field.

Specified by:

getFieldSorts in interface NavigableField

Parameters:

sortOrder - the order in which to sort the field

Returns:

a list of FieldSort objects that can be used to sort this field

getEditTemplateName

protected String getEditTemplateName()

Specified by:

getEditTemplateName in class AbstractTextSystemField

getColumnViewTemplateName

protected String getColumnViewTemplateName()

Specified by:

getColumnViewTemplateName in class AbstractTextSystemField

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<String>

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.

getRestFieldOperation

public RestFieldOperationsHandler getRestFieldOperation()

Specified by:

getRestFieldOperation in interface RestFieldOperations

Returns:

the RestFieldOperationsHandler for this field.

getJsonDefaultValue

public JsonData getJsonDefaultValue(IssueContext issueCtx)

Description copied from interface: RestFieldOperations

Return The default data for this system field. May be null if there is no default.

Specified by:

getJsonDefaultValue in interface RestFieldOperations

Parameters:

issueCtx - Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.

getConfigurationItemTypes

public List<FieldConfigItemType> getConfigurationItemTypes()

Description copied from interface: ConfigurableField

Returns a List of FieldConfigItemType objects. This opens up possibilties for configurable custom fields

Specified by:

getConfigurationItemTypes in interface ConfigurableField<String>

Returns:

List of FieldConfigItemType @Nonnull

getAssociatedProjectObjects

public List<Project> getAssociatedProjectObjects()

Description copied from interface: ConfigurableField

Returns a list of projects associated with this field. Will be null if the field is global

Specified by:

getAssociatedProjectObjects in interface ConfigurableField<String>

Returns:

a list of projects associated with this field.

getRelevantConfig

public FieldConfig getRelevantConfig(IssueContext issueContext)

Specified by:

getRelevantConfig in interface ConfigurableField<String>

getDefaultValueOperations

public DefaultValueOperations<String> getDefaultValueOperations()

Specified by:

getDefaultValueOperations in interface DefaultValueField<String>