com.atlassian.jira.issue.customfields.impl
Class UserCFType
java.lang.Object
com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
com.atlassian.jira.issue.customfields.impl.StringCFType
com.atlassian.jira.issue.customfields.impl.UserCFType
- All Implemented Interfaces:
- CustomFieldType, SortableCustomField, UserCFNotificationTypeAware
public class UserCFType
- extends StringCFType
- implements SortableCustomField, UserCFNotificationTypeAware
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType |
assertObjectImplementsType, availableForBulkEdit, getChangelogString, getConfigurationItemTypes, 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 |
UserCFType
public UserCFType(CustomFieldValuePersister customFieldValuePersister,
UserConverter userConverter,
GenericConfigManager genericConfigManager,
ApplicationProperties applicationProperties,
JiraAuthenticationContext authenticationContext,
UserPickerSearchService searchService)
getStringFromSingularObject
public String getStringFromSingularObject(Object value)
- 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
- 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
- Returns:
- singularObject instance
- Throws:
FieldValidationException
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
- Overrides:
validateFromParams
in class AbstractSingleFieldType
- Parameters:
relevantParams
- parameter object of StringserrorCollectionToAddTo
- errorCollection to which any erros should be added (never null)
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
- Overrides:
getValueFromCustomFieldParams
in class AbstractSingleFieldType
- 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)
compare
public int compare(Object customFieldObjectValue1,
Object customFieldObjectValue2,
FieldConfig fieldConfig)
- Description copied from interface:
SortableCustomField
- Compares the two custom field objects.
- Specified by:
compare
in interface SortableCustomField
- Specified by:
compare
in class StringCFType
- Parameters:
customFieldObjectValue1
- Never nullcustomFieldObjectValue2
- Never null
- Returns:
- 0, 1 or -1
getDatabaseType
protected PersistenceFieldType getDatabaseType()
- Description copied from class:
AbstractSingleFieldType
- Type of database field needed to store this field.
- Specified by:
getDatabaseType
in class StringCFType
- Returns:
- One of the predefined
PersistenceFieldType
types.
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')
- Returns:
- A
Map
of parameters to add to the velocity context, or an empty Map otherwise (never null)
Copyright © 2002-2007 Atlassian. All Rights Reserved.