com.atlassian.jira.issue.customfields.impl
Class CalculatedCFType

java.lang.Object
  com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
      com.atlassian.jira.issue.customfields.impl.CalculatedCFType

All Implemented Interfaces:

CustomFieldType, SortableCustomField

public abstract class CalculatedCFType
extends AbstractCustomFieldType
implements SortableCustomField

Nested Class Summary

static interface

CalculatedCFType.Visitor<T>

Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

AbstractCustomFieldType.VisitorBase<T>

Field Summary

Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

DEFAULT_VALUE_TYPE

Constructor Summary

CalculatedCFType()

Method Summary

Object	accept(AbstractCustomFieldType.VisitorBase visitor)
int	compare(Object o1, Object o2, FieldConfig fieldConfig) Compares the two custom field objects.
void	createValue(CustomField field, Issue issue, Object value)
String	getChangelogValue(CustomField field, Object value) Returns a values to be stored in the change log, example is the id of the changed item.
List	getConfigurationItemTypes() Returns a List of FieldConfigItemType objects.
Object	getDefaultValue(FieldConfig fieldConfig) Retrieves the Object representing the default CustomField value for the Custom Field.
Object	getStringValueFromCustomFieldParams(CustomFieldParams parameters) Return the String value object from the CustomFieldParams.
Object	getValueFromCustomFieldParams(CustomFieldParams parameters) Retrieves the Object representing the CustomField value instance from the CustomFieldParams of Strings.
Set	remove(CustomField field) Performs additional tasks when a CustomField of this type is being removed CustomField.remove().
void	removeValue(CustomField arg0, org.ofbiz.core.entity.GenericValue arg1, Object arg2)
void	setDefaultValue(FieldConfig fieldConfig, Object value) Sets the default value for a Custom Field
void	updateValue(CustomField field, Issue issue, Object value)
void	validateFromParams(CustomFieldParams relevantParams, ErrorCollection errorCollectionToAddTo, FieldConfig config) Ensures that the CustomFieldParams of Strings is a valid representation of the Custom Field values.

Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

assertObjectImplementsType, availableForBulkEdit, getChangelogString, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, getVelocityParameters, init, isRenderable, valuesEqual

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

getSingularObjectFromString, getStringFromSingularObject, getValueFromIssue

Constructor Detail

CalculatedCFType

public CalculatedCFType()

Method Detail

remove

public Set remove(CustomField field)

Description copied from interface: CustomFieldType

Performs additional tasks when a CustomField of this type is being removed CustomField.remove(). This includes removal of values & options.

Specified by:

remove in interface CustomFieldType

Parameters:

field - The custom field that is being removed, so any data stored for any issues for that field can be deleted.

Returns:

Set of issue ids that has been affected

validateFromParams

public void validateFromParams(CustomFieldParams relevantParams,
                               ErrorCollection errorCollectionToAddTo,
                               FieldConfig config)

Description copied from interface: CustomFieldType

Ensures that the CustomFieldParams of Strings is a valid representation of the Custom Field values. Any errors should be added to the ErrorCollection under the appropriate key as required.

Specified by:

validateFromParams in interface CustomFieldType

Parameters:

relevantParams - parameter object of Strings

errorCollectionToAddTo - errorCollection to which any erros should be added (never null)

config - FieldConfig

createValue

public void createValue(CustomField field,
                        Issue issue,
                        Object value)

Specified by:

createValue in interface CustomFieldType

updateValue

public void updateValue(CustomField field,
                        Issue issue,
                        Object value)

Specified by:

updateValue in interface CustomFieldType

removeValue

public void removeValue(CustomField arg0,
                        org.ofbiz.core.entity.GenericValue arg1,
                        Object arg2)

getDefaultValue

public Object getDefaultValue(FieldConfig fieldConfig)

Description copied from interface: CustomFieldType

Retrieves the Object representing the default CustomField value for the Custom Field. See CustomFieldType.getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams) for more detailed notes.

Specified by:

getDefaultValue in interface CustomFieldType

Parameters:

fieldConfig - CustomField for default value

Returns:

Transport Object matching the Object parameter of CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.Object), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.Object)

setDefaultValue

public void setDefaultValue(FieldConfig fieldConfig,
                            Object value)

Description copied from interface: CustomFieldType

Sets the default value for a Custom Field

Specified by:

setDefaultValue in interface CustomFieldType

Parameters:

fieldConfig - CustomField for which the default is being stored

value - Transport Object representing the value instance of the CustomField

getChangelogValue

public String getChangelogValue(CustomField field,
                                Object value)

Description copied from interface: CustomFieldType

Returns a values to be stored in the change log, example is the id of the changed item.

Specified by:

getChangelogValue in interface CustomFieldType

Parameters:

field - CustomField that the value belongs to

value - Transport Object representing the value instance of the CustomField

Returns:

Change log value.

getValueFromCustomFieldParams

public Object getValueFromCustomFieldParams(CustomFieldParams parameters)
                                     throws FieldValidationException

Description copied from interface: CustomFieldType

Retrieves the Object representing the CustomField value instance from the CustomFieldParams of Strings. This return type must exactly match that of the value Object parameter in the persistance methods (CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.Object), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.Object)) and Object returned from CustomFieldType.getValueFromIssue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue).

Specified by:

getValueFromCustomFieldParams in interface CustomFieldType

Parameters:

parameters - CustomFieldParams of String objects. Will contain one value for Singular field types.

Returns:

Transport Object matching the Object parameter of CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.Object), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.Object)

Throws:

FieldValidationException - if the String value fails to convert into Objects

See Also:

CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, Object), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, Object), CustomFieldType.getValueFromIssue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue)

getStringValueFromCustomFieldParams

public Object getStringValueFromCustomFieldParams(CustomFieldParams parameters)

Description copied from interface: CustomFieldType

Return the String value object from the CustomFieldParams. The object may be a single String (e.g. TextCFType, List of Strings (e.g. MultiSelectCFType) or CustomFieldParams of Strings (e.g. CascadingSelectCFType)

Specified by:

getStringValueFromCustomFieldParams in interface CustomFieldType

Parameters:

parameters - - CustomFieldParams containing String values

Returns:

String value object from the CustomFieldParams

compare

public int compare(Object o1,
                   Object o2,
                   FieldConfig fieldConfig)

Description copied from interface: SortableCustomField

Compares the two custom field objects.

Specified by:

compare in interface SortableCustomField

Parameters:

o1 - Never null

o2 - Never null

Returns:

0, 1 or -1

getConfigurationItemTypes

public List getConfigurationItemTypes()

Description copied from interface: CustomFieldType

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

Specified by:

getConfigurationItemTypes in interface CustomFieldType

Overrides:

getConfigurationItemTypes in class AbstractCustomFieldType

Returns:

List of FieldConfigItemType

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class AbstractCustomFieldType