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

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<T,T>
      extended by com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType<String>
          extended by com.atlassian.jira.issue.customfields.impl.GenericTextCFType
              extended by com.atlassian.jira.issue.customfields.impl.ReadOnlyCFType
All Implemented Interfaces:
ProjectImportableCustomField, CustomFieldType<String,String>, SortableCustomField<String>, RestAwareCustomFieldType, RestCustomFieldTypeOperations

public class ReadOnlyCFType
extends GenericTextCFType


Nested Class Summary
static interface ReadOnlyCFType.Visitor<T>
           
 
Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
AbstractCustomFieldType.VisitorBase<X>
 
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, RESOURCE_PREVIEW
 
Constructor Summary
ReadOnlyCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager)
           
ReadOnlyCFType(CustomFieldValuePersister customFieldValuePersister, StringConverter stringConverter, GenericConfigManager genericConfigManager)
          Deprecated. Use ReadOnlyCFType(com.atlassian.jira.issue.customfields.persistence.CustomFieldValuePersister, com.atlassian.jira.issue.customfields.manager.GenericConfigManager) instead. Since v5.0.
 
Method Summary
 Object accept(AbstractCustomFieldType.VisitorBase visitor)
           
 String availableForBulkEdit(BulkEditBean bulkEditBean)
          Allow the custom field type perform a specific check as to its availability for bulk editing.
 String getChangelogValue(CustomField field, String value)
          Returns a values to be stored in the change log, example is the id of the changed item.
 void updateValue(CustomField customField, Issue issue, String value)
          the value does exist, and the new value is different than the existing one.
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.GenericTextCFType
compare, getDatabaseType, getDbValueFromObject, getFieldTypeInfo, getJsonFromIssue, getJsonSchema, getObjectFromDbValue, getProjectImporter, getRestFieldOperation, getSingularObjectFromString, getStringFromSingularObject
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
createValue, getDefaultValue, getJsonDefaultValue, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, getValueFromIssue, getValueFromIssue, remove, setDefaultValue, validateFromParams
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
assertObjectImplementsType, 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
 
Methods inherited from interface com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations
getJsonDefaultValue
 

Constructor Detail

ReadOnlyCFType

public ReadOnlyCFType(CustomFieldValuePersister customFieldValuePersister,
                      GenericConfigManager genericConfigManager)

ReadOnlyCFType

@Deprecated
public ReadOnlyCFType(CustomFieldValuePersister customFieldValuePersister,
                                 StringConverter stringConverter,
                                 GenericConfigManager genericConfigManager)
Deprecated. Use ReadOnlyCFType(com.atlassian.jira.issue.customfields.persistence.CustomFieldValuePersister, com.atlassian.jira.issue.customfields.manager.GenericConfigManager) instead. Since v5.0.

Parameters:
customFieldValuePersister -
stringConverter -
genericConfigManager -
Method Detail

updateValue

public void updateValue(CustomField customField,
                        Issue issue,
                        String value)
Description copied from class: AbstractSingleFieldType
the value does exist, and the new value is different than the existing one.

Specified by:
updateValue in interface CustomFieldType<String,String>
Overrides:
updateValue in class AbstractSingleFieldType<String>
Parameters:
customField - CustomField for which the value is being stored
issue - The Issue to be stored against.
value - Transport Object representing the value instance of the CustomField.

getChangelogValue

public String getChangelogValue(CustomField field,
                                String 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<String,String>
Overrides:
getChangelogValue in class AbstractSingleFieldType<String>
Parameters:
field - CustomField that the value belongs to
value - Transport Object representing the value instance of the CustomField
Returns:
Change log value.

availableForBulkEdit

public String availableForBulkEdit(BulkEditBean bulkEditBean)
Description copied from interface: CustomFieldType
Allow the custom field type perform a specific check as to its availability for bulk editing.

Specified by:
availableForBulkEdit in interface CustomFieldType<String,String>
Overrides:
availableForBulkEdit in class AbstractCustomFieldType<String,String>
Parameters:
bulkEditBean - BulkEditBean
Returns:
null if available for bulk edit or appropriate unavailable message

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)
Overrides:
accept in class GenericTextCFType


Copyright © 2002-2014 Atlassian. All Rights Reserved.