Package com.atlassian.jira.issue.fields

Class DefaultValueOperationsCF<T>

java.lang.Object

com.atlassian.jira.issue.fields.DefaultValueOperationsCF<T>

All Implemented Interfaces:

DefaultValueOperations<T>

@Internal
public class DefaultValueOperationsCF<T>
extends Object
implements DefaultValueOperations<T>

Field Summary

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

NOT_SUPPORTED

Constructor Summary

Constructors

Constructor	Description
DefaultValueOperationsCF(CustomFieldType<T,?> customFieldType)

Method Summary

Modifier and Type	Method	Description
T	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.
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, T value)	Sets the default value for a FieldConfig
void	validateFromActionParams(FieldConfig config, Map actionParameters, ErrorCollection errorCollection)	Validate action parameters prior to saving default value.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultValueOperationsCF

public DefaultValueOperationsCF(@Nonnull
 CustomFieldType<T,?> customFieldType)

Method Details

getDefaultValue

@Nullable
public T getDefaultValue(@Nonnull
 FieldConfig fieldConfig)

Description copied from interface: DefaultValueOperations

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

Specified by:

getDefaultValue in interface DefaultValueOperations<T>

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

public void setDefaultValue(@Nonnull
 FieldConfig fieldConfig,
 @Nullable
 T value)

Description copied from interface: DefaultValueOperations

Sets the default value for a FieldConfig

Specified by:

setDefaultValue in interface DefaultValueOperations<T>

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

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

Description copied from interface: DefaultValueOperations

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

Specified by:

populateDefaults in interface DefaultValueOperations<T>

Parameters:

fieldConfig -

fieldValuesHolder -

See Also:

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

validateFromActionParams

public void validateFromActionParams(@Nonnull
 FieldConfig config,
 @Nonnull
 Map actionParameters,
 @Nonnull
 ErrorCollection errorCollection)

Description copied from interface: DefaultValueOperations

Validate action parameters prior to saving default value.

Specified by:

validateFromActionParams in interface DefaultValueOperations<T>

Parameters:

config -

actionParameters -

errorCollection -

See Also:

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

getViewHtml

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

Description copied from interface: DefaultValueOperations

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

Specified by:

getViewHtml in interface DefaultValueOperations<T>

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

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

Description copied from interface: DefaultValueOperations

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

Specified by:

getEditHtml in interface DefaultValueOperations<T>

Parameters:

config -

customFieldValuesHolder -

action -

displayParameters -

fieldLayoutItem -

Returns:

See Also:

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

isSupport

public boolean isSupport()

Description copied from interface: DefaultValueOperations

Returns true if default values are supported, false otherwise.

Specified by:

isSupport in interface DefaultValueOperations<T>

Returns:

true if default values are supported, false otherwise.