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

java.lang.Object
  extended bycom.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
      extended bycom.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
          extended bycom.atlassian.jira.issue.customfields.impl.StringCFType
              extended bycom.atlassian.jira.issue.customfields.impl.UserCFType
All Implemented Interfaces:
CustomFieldType, SortableCustomField

public class UserCFType
extends StringCFType
implements SortableCustomField


Field Summary
 
Fields inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
customFieldValuePersister, FIELD_TYPE_DATE, FIELD_TYPE_NUMBER, FIELD_TYPE_STRING, FIELD_TYPE_TEXT, genericConfigManager, log
 
Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType
DEFAULT_VALUE_TYPE
 
Constructor Summary
UserCFType(CustomFieldValuePersister customFieldValuePersister, UserConverter userConverter, GenericConfigManager genericConfigManager)
           
 
Method Summary
 int compare(Object customFieldObjectValue1, Object customFieldObjectValue2, FieldConfig fieldConfig)
          Comapares the two custom field objects.
protected  PersistenceFieldType getDatabaseType()
          Type of database field needed to store this field.
 Object getSingularObjectFromString(String string)
          Returns a Singular Object, given the string value as passed by the presentation tier.
 String getStringFromSingularObject(Object value)
          Returns the String representation of a single value within the CustomFieldType.
 Object getValueFromCustomFieldParams(CustomFieldParams relevantParams)
          Retrieves the Object representing the CustomField value instance from the CustomFieldParams of Strings.
 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.StringCFType
getDbValueFromObject, getObjectFromDbValue, makeSearchParameter
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
createValue, getChangelogValue, getDefaultValue, getStringValueFromCustomFieldParams, getValueFromIssue, remove, setDefaultValue, updateValue
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
assertObjectImplementsType, availableForBulkEdit, getChangelogString, getConfigurationItemTypes, 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
 

Constructor Detail

UserCFType

public UserCFType(CustomFieldValuePersister customFieldValuePersister,
                  UserConverter userConverter,
                  GenericConfigManager genericConfigManager)
Method Detail

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
Parameters:
value -
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 -
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

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
Throws:
FieldValidationException

compare

public int compare(Object customFieldObjectValue1,
                   Object customFieldObjectValue2,
                   FieldConfig fieldConfig)
Description copied from interface: SortableCustomField
Comapares the two custom field objects.

Specified by:
compare in interface SortableCustomField
Specified by:
compare in class StringCFType

getDatabaseType

protected PersistenceFieldType getDatabaseType()
Description copied from class: AbstractSingleFieldType
Type of database field needed to store this field.

Specified by:
getDatabaseType in class StringCFType


Copyright © 2002-2006 Atlassian. All Rights Reserved.