Package com.atlassian.jira.issue.fields

Interface DefaultValueOperations<V>

All Known Implementing Classes:

DefaultValueOperationsCF

@ExperimentalApi
@PublicApi
public interface DefaultValueOperations<V>

Interface that defines set of operations that need to be implemented by "System fields"/"Custom fields"/"Custom field types" in order to support "default values". The methods listed below are used in various places across jira to provide support for "default values".

Displaying "default values" is implemented in ConfigureCustomField in jira core. This action makes use of ConfigurableField.getConfigurationItemTypes() to display FieldConfigItemType for particular field contexts. This action also renders link for editing default value DefaultValueConfigItem.

The main class for managing "default values" is EditCustomFieldDefaults class in jira core. Basically the workflow is as follows: - go to edit page from "view field contexts" page. - populate defaults: populateDefaults(FieldConfig, Map) - render "edit" page: getEditHtml(com.atlassian.jira.issue.fields.config.FieldConfig, java.util.Map, webwork.action.Action, java.util.Map, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem) and getDefaultValue(com.atlassian.jira.issue.fields.config.FieldConfig) + using values populated in previous step - after saving validation is performed: validateFromActionParams(FieldConfig, Map, ErrorCollection) - after positive validation value is saved: OrderableField.populateFromParams(java.util.Map, java.util.Map) OrderableField.getValueFromParams(java.util.Map) setDefaultValue(com.atlassian.jira.issue.fields.config.FieldConfig, java.lang.Object)

Since:

8.16

Field Summary

Fields

Modifier and Type	Field	Description
static final DefaultValueOperations	NOT_SUPPORTED

Method Summary

Modifier and Type	Method	Description
V	getDefaultValue(FieldConfig fieldConfig)	Retrieves the Object representing the default field value for the Field and FieldConfig.
String	getEditHtml(FieldConfig config, Map customFieldValuesHolder, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)	Used during editing default value to render field.
String	getViewHtml(FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)	Gets view html used on ConfigureCustomField page (manage field contexts) to display field configuration items for "default value".
boolean	isSupport()	Returns true if default values are supported, false otherwise.
static <T> DefaultValueOperations<T>	notSupported()
void	populateDefaults(FieldConfig fieldConfig, Map<String,Object> fieldValuesHolder)	Populate the fieldValuesHolder with a value that should be shown by default when the edit default value page is shown.
void	setDefaultValue(FieldConfig fieldConfig, V value)	Sets the default value for a FieldConfig
void	validateFromActionParams(FieldConfig config, Map<String,Object> actionParameters, ErrorCollection errorCollection)	Validate action parameters prior to saving default value.

Field Details

NOT_SUPPORTED

static final DefaultValueOperations NOT_SUPPORTED

Method Details

notSupported

static <T> DefaultValueOperations<T> notSupported()

getDefaultValue

@Nullable
V getDefaultValue(@Nonnull
 FieldConfig fieldConfig)

Retrieves the Object representing the default field value for the Field and FieldConfig.

Parameters:

fieldConfig - for default value

Returns:

Transport Object of the Default Value

See Also:

• CustomFieldType.getDefaultValue(com.atlassian.jira.issue.fields.config.FieldConfig)
• FieldConfig

setDefaultValue

void setDefaultValue(@Nonnull
 FieldConfig fieldConfig,
 @Nullable
 V value)

Sets the default value for a FieldConfig

Parameters:

fieldConfig - for which the default is being stored

value - Transport Object representing the value instance of the CustomField

See Also:

• EditCustomFieldDefaults.doExecute()
• CustomFieldType.setDefaultValue(com.atlassian.jira.issue.fields.config.FieldConfig, java.lang.Object)
• FieldConfig

populateDefaults

void populateDefaults(@Nonnull
 FieldConfig fieldConfig,
 @Nonnull
 Map<String,Object> fieldValuesHolder)

Populate the fieldValuesHolder with a value that should be shown by default when the edit default value page is shown. Used together with getEditHtml(FieldConfig, Map, Action, Map, FieldLayoutItem)}

Parameters:

fieldConfig -

fieldValuesHolder -

See Also:

• getEditHtml(FieldConfig, Map, Action, Map, FieldLayoutItem)
• EditCustomFieldDefaults.getCustomFieldHtml()

getViewHtml

String getViewHtml(@Nonnull
 FieldConfig fieldConfig,
 @Nullable
 FieldLayoutItem fieldLayoutItem)

Gets view html used on ConfigureCustomField page (manage field contexts) to display field configuration items for "default value".

Parameters:

fieldConfig -

fieldLayoutItem -

Returns:

See Also:

• FieldConfigItemImpl.getViewHtml(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem)
• FieldConfigItemType.getViewHtml(com.atlassian.jira.issue.fields.config.FieldConfig, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem)
• DefaultValueConfigItem.getViewHtml(com.atlassian.jira.issue.fields.config.FieldConfig, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem)
• DefaultValueConfigItem.getViewHtml(com.atlassian.jira.issue.fields.config.FieldConfig, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem)
• CustomFieldTypeModuleDescriptor.getDefaultViewHtml(com.atlassian.jira.issue.fields.config.FieldConfig, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem)

getEditHtml

String getEditHtml(@Nonnull
 FieldConfig config,
 @Nonnull
 Map customFieldValuesHolder,
 webwork.action.Action action,
 Map displayParameters,
 FieldLayoutItem fieldLayoutItem)

Used during editing default value to render field. Display parameters are populated by populateDefaults(FieldConfig, Map) called prior to this method.

Parameters:

config -

customFieldValuesHolder -

action -

displayParameters -

fieldLayoutItem -

Returns:

See Also:

• populateDefaults(FieldConfig, Map)
• EditCustomFieldDefaults.getCustomFieldHtml()

validateFromActionParams

void validateFromActionParams(@Nonnull
 FieldConfig config,
 @Nonnull
 Map<String,Object> actionParameters,
 @Nonnull
 ErrorCollection errorCollection)

Validate action parameters prior to saving default value.

Parameters:

config -

actionParameters -

errorCollection -

See Also:

• EditCustomFieldDefaults.doValidation()
• OrderableField.populateFromParams(java.util.Map, java.util.Map)
• setDefaultValue(FieldConfig, Object)

isSupport

boolean isSupport()

Returns true if default values are supported, false otherwise.

Returns:

true if default values are supported, false otherwise.