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

java.lang.Object
  com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
      com.atlassian.jira.issue.customfields.impl.AbstractMultiSettableCFType
          com.atlassian.jira.issue.customfields.impl.CascadingSelectCFType

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType, MultipleCustomFieldType, MultipleSettableCustomFieldType, SortableCustomField

public class CascadingSelectCFType
extends AbstractMultiSettableCFType
implements MultipleSettableCustomFieldType, SortableCustomField, ProjectImportableCustomField

Cascading Select Custom Field Type allows for multiple dependent select lists.

Transport Object Type

CustomFieldParams The key in the CustomFieldParams object represents the field depth of the select list. eg. a key of null is the root parent, and key of "1" is the first level select list. As at JIRA 3.0, there can only be one level.

Singular Object Type

Option

Field Summary

static PersistenceFieldType	CASCADE_VALUE_TYPE
static String	CHILD_KEY
static String	PARENT_KEY

Fields inherited from class com.atlassian.jira.issue.customfields.impl.AbstractMultiSettableCFType

customFieldValuePersister, genericConfigManager, optionsManager

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

DEFAULT_VALUE_TYPE

Constructor Summary

CascadingSelectCFType(OptionsManager optionsManager, CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager)

Method Summary

int	compare(Object o1, Object o2, FieldConfig fieldConfig) Compares the two custom field objects.
int	compareOption(Option option1, Option option2)
void	createValue(CustomField field, Issue issue, Object value) Create a cascading select-list instance for an issue.
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.
Set	getIssueIdsWithValue(CustomField field, Option option) Returns a list of Issue Ids matching the "value" note that the value in this instance is the single object
ProjectCustomFieldImporter	getProjectImporter() Returns the object that will perform the actual project import functions for the custom field type.
Object	getSingularObjectFromString(String string) Returns a Singular Object, given the string value as passed by the presentation tier.
String	getStringFromSingularObject(Object optionObject) Returns the String representation of a single value within the CustomFieldType.
Object	getStringValueFromCustomFieldParams(CustomFieldParams parameters) Return the String value object from the CustomFieldParams.
Object	getValueFromCustomFieldParams(CustomFieldParams relevantParams) Retrieves the Object representing the CustomField value instance from the CustomFieldParams of Strings.
Object	getValueFromIssue(CustomField field, Issue issue) Retrieves the Object representing the current CustomField value for the given issue.
Map	getVelocityParameters(Issue issue, CustomField field, FieldLayoutItem fieldLayoutItem) The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).
void	removeValue(CustomField field, Issue issue, Option option)
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.AbstractMultiSettableCFType

getOptions, remove

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

assertObjectImplementsType, availableForBulkEdit, getChangelogString, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, 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.MultipleCustomFieldType

getOptions

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

availableForBulkEdit, getChangelogString, getDescription, getDescriptor, getKey, getName, getRelatedIndexers, init, isRenderable, remove, valuesEqual

Field Detail

PARENT_KEY

public static final String PARENT_KEY

CHILD_KEY

public static final String CHILD_KEY

See Also:

Constant Field Values

CASCADE_VALUE_TYPE

public static final PersistenceFieldType CASCADE_VALUE_TYPE

Constructor Detail

CascadingSelectCFType

public CascadingSelectCFType(OptionsManager optionsManager,
                             CustomFieldValuePersister customFieldValuePersister,
                             GenericConfigManager genericConfigManager)

Method Detail

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)

Create a cascading select-list instance for an issue.

Specified by:

createValue in interface CustomFieldType

Parameters:

value - Must be a CustomFieldParams, or the method has no effect.

updateValue

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

Specified by:

updateValue in interface CustomFieldType

removeValue

public void removeValue(CustomField field,
                        Issue issue,
                        Option option)

Specified by:

removeValue in interface MultipleSettableCustomFieldType

getValueFromIssue

public Object getValueFromIssue(CustomField field,
                                Issue issue)

Description copied from interface: CustomFieldType

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

Specified by:

getValueFromIssue in interface CustomFieldType

Parameters:

field - Custom field for which to retrieve the value

issue - Issue from which to retrieve the 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)

See Also:

CustomFieldType.getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams)

getValueFromCustomFieldParams

public Object getValueFromCustomFieldParams(CustomFieldParams relevantParams)
                                     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:

relevantParams - 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, java.lang.Object), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.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

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.

getIssueIdsWithValue

public Set getIssueIdsWithValue(CustomField field,
                                Option option)

Returns a list of Issue Ids matching the "value" note that the value in this instance is the single object

Specified by:

getIssueIdsWithValue in interface MultipleSettableCustomFieldType

Parameters:

field -

option -

Returns:

Set of Longs

getStringFromSingularObject

public String getStringFromSingularObject(Object optionObject)

Description copied from interface: CustomFieldType

Returns the String representation of a single value within the CustomFieldType. This is the value that will is passed to the presentation tier for editing. For single CustomFieldTypes the Singular Object is the same as a Transport Object. However, for multi-dimensional CustomFieldTypes, the Singular Object is the Object contained within the Collection or CustomFieldParams

Specified by:

getStringFromSingularObject in interface CustomFieldType

Parameters:

optionObject - the object

Returns:

String representation of the Object

getSingularObjectFromString

public Object getSingularObjectFromString(String string)
                                   throws FieldValidationException

Description copied from interface: CustomFieldType

Returns a Singular Object, given the string value as passed by the presentation tier. Throws FieldValidationException if the string is an invalid representation of the Object.

Specified by:

getSingularObjectFromString in interface CustomFieldType

Parameters:

string - the String

Returns:

singularObject instance

Throws:

FieldValidationException - if the string is an invalid representation of the Object.

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

getVelocityParameters

public Map getVelocityParameters(Issue issue,
                                 CustomField field,
                                 FieldLayoutItem fieldLayoutItem)

Description copied from interface: CustomFieldType

The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).

The values are added to the context for all velocity views (edit, search, view, xml)

Specified by:

getVelocityParameters in interface CustomFieldType

Overrides:

getVelocityParameters in class AbstractCustomFieldType

Parameters:

issue - The issue currently in context (Note: this will be null in cases like 'default value')

field - CustomField

fieldLayoutItem - FieldLayoutItem

Returns:

A Map of parameters to add to the velocity context, or an empty Map otherwise (never null)

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

compareOption

public int compareOption(Option option1,
                         Option option2)

getProjectImporter

public ProjectCustomFieldImporter getProjectImporter()

Description copied from interface: ProjectImportableCustomField

Returns the object that will perform the actual project import functions for the custom field type.

Specified by:

getProjectImporter in interface ProjectImportableCustomField

Returns:

the object that will perform the actual project import functions for the custom field type.