com.atlassian.jira.issue.customfields

Interface CustomFieldValueProvider

All Known Implementing Classes:

DefaultCustomFieldValueProvider, MultiSelectCustomFieldValueProvider, NumberRangeCustomFieldValueProvider, ProjectCustomFieldValueProvider, SelectCustomFieldValueProvider, SingleValueCustomFieldValueProvider

@PublicSpi
public interface CustomFieldValueProvider

Provides access to custom field values for the purpose of rendering with custom field searchers.

Since:

v4.0

Method Summary

Methods

Modifier and Type	Method and Description
Object	getStringValue(CustomField customField, FieldValuesHolder fieldValuesHolder) Provides a string value representation of the value specified for this searcher.
Object	getValue(CustomField customField, FieldValuesHolder fieldValuesHolder) Provides an object value representation of the value specified for this searcher.

Method Detail

getStringValue

Object getStringValue(CustomField customField,
                    FieldValuesHolder fieldValuesHolder)

Provides a string value representation of the value specified for this searcher. The result is used to populate the velocity context with the variable "value".

Parameters:

customField - the custom field that is using this searcher.

fieldValuesHolder - contains values populated by the populate methods of the input transformer.

Returns:

a string value representation of the value specified for this searcher.

getValue

Object getValue(CustomField customField,
              FieldValuesHolder fieldValuesHolder)

Provides an object value representation of the value specified for this searcher. The result is used to populate the velocity context with the variable "valueObject".

Parameters:

customField - the custom field that is using this searcher.

fieldValuesHolder - contains values populated by the populate methods of the input transformer.

Returns:

an object value representation of the value specified for this searcher.