com.atlassian.jira.issue.fields

Class AttachmentSystemField

java.lang.Object

com.atlassian.jira.issue.fields.AbstractField

com.atlassian.jira.issue.fields.AbstractOrderableField<List<String>>

com.atlassian.jira.issue.fields.AttachmentSystemField

All Implemented Interfaces:

ExportableSystemField, Field, HideableField, OrderableField<List<String>>, RestAwareField, SearchableField, Comparable

public class AttachmentSystemField
extends AbstractOrderableField<List<String>>
implements HideableField, RestAwareField, ExportableSystemField

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILETOCONVERT

Fields inherited from class com.atlassian.jira.issue.fields.AbstractField

authenticationContext

Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField

MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH

Constructor Summary

Constructors

Constructor and Description

AttachmentSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, AttachmentManager attachmentManager, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, JiraBaseUrls jiraBaseUrls, ThumbnailManager thumbnailManager, DateTimeFormatterFactory dateTimeFormatterFactory, EmailFormatter emailFormatter, BackwardCompatibleTemporaryAttachmentUtil temporaryAttachmentUtil, AttachmentJsonBeanConverter attachmentJsonBeanConverter, CsvDateFormatter csvDateFormatter, AttachmentValidator attachmentValidator, WorkflowManager workflowManager)

Method Summary

Modifier and Type	Method and Description
String	availableForBulkEdit(BulkEditBean bulkEditBean) Determines whether the field is available for bulk editing given the BulkEditBean.
boolean	canRemoveValueFromIssueObject(Issue issue) Returns true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.
void	createValue(Issue issue, List<String> value) Create the value of the issue in the data store.
String	getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns the HTML that should be shown when the issue is being created.
List<String>	getDefaultValue(Issue issue) The value that should be set on the issue if the field is not shown for some reason.
String	getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns HTML that should be shown when the issue is being edited.
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.
FieldJsonRepresentation	getJsonFromIssue(Issue issue, boolean renderedVersionRequired, FieldLayoutItem fieldLayoutItem) Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.
JsonType	getJsonSchema() Return a description of the shape of this field when represented as JSON.
protected Object	getRelevantParams(Map<String,String[]> params)
FieldExportParts	getRepresentationFromIssue(Issue issue) This will output a single FieldExportPart with multiple attachment values in it.
List<String>	getValueFromParams(Map params) Get a field value from the map of parameters passed.
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, List<String> value, Map displayParameters)
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
boolean	hasValue(Issue issue) Determines if the field has a value for the given issue.
boolean	isShown(Issue issue) Tests field specific way to determine if it should be shown or not.
MessagedResult	needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem) Used to determine if the field needs input from user to be moved to the new project and/or issue type.
void	populateDefaults(Map<String,Object> fieldValuesHolder, Issue issue) Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.
void	populateForMove(Map<String,Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue) Used to populate the fieldValueHolder with parameters for move issue screen.
void	populateFromIssue(Map<String,Object> fieldValuesHolder, Issue issue) Used to initialise the fieldValuesHolder from the current value of teh issue.
void	populateParamsFromString(Map<String,Object> fieldValuesHolder, String stringValue, Issue issue) Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
void	removeValueFromIssueObject(MutableIssue issue) Removes the field value from the given MutableIssue object.
void	updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder) Record the value on the issue (not saving it to the database, see updateValue).
void	updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) Update the issue in the data store.
void	validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Ensure that the parameters are valid

Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField

createAssociatedSearchHandler, getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getVelocityParams, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, validateBulkEditHtmlProperties, valuesEqual

Methods inherited from class com.atlassian.jira.issue.fields.AbstractField

compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.fields.Field

getId, getName, getNameKey

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

FILETOCONVERT

public static final String FILETOCONVERT

See Also:

Constant Field Values

Constructor Detail

AttachmentSystemField

public AttachmentSystemField(VelocityTemplatingEngine templatingEngine,
                             ApplicationProperties applicationProperties,
                             AttachmentManager attachmentManager,
                             JiraAuthenticationContext authenticationContext,
                             PermissionManager permissionManager,
                             JiraBaseUrls jiraBaseUrls,
                             ThumbnailManager thumbnailManager,
                             DateTimeFormatterFactory dateTimeFormatterFactory,
                             EmailFormatter emailFormatter,
                             BackwardCompatibleTemporaryAttachmentUtil temporaryAttachmentUtil,
                             AttachmentJsonBeanConverter attachmentJsonBeanConverter,
                             CsvDateFormatter csvDateFormatter,
                             AttachmentValidator attachmentValidator,
                             WorkflowManager workflowManager)

Method Detail

getCreateHtml

public String getCreateHtml(FieldLayoutItem fieldLayoutItem,
                            OperationContext operationContext,
                            webwork.action.Action action,
                            Issue issue,
                            Map displayParameters)

Description copied from interface: OrderableField

Returns the HTML that should be shown when the issue is being created.

Specified by:

getCreateHtml in interface OrderableField<List<String>>

Parameters:

fieldLayoutItem - FieldLayoutItem

operationContext - OperationContext

action - Action

issue - Issue

displayParameters - Map of display parameters.

Returns:

the HTML that should be shown when the issue is being created.

getEditHtml

public String getEditHtml(FieldLayoutItem fieldLayoutItem,
                          OperationContext operationContext,
                          webwork.action.Action action,
                          Issue issue,
                          Map displayParameters)

Description copied from interface: OrderableField

Returns HTML that should be shown when the issue is being edited.

Specified by:

getEditHtml in interface OrderableField<List<String>>

Parameters:

fieldLayoutItem - FieldLayoutItem

operationContext - OperationContext

action - Action

issue - Issue

displayParameters - Map of display parameters.

Returns:

HTML that should be shown when the issue is being edited.

getViewHtml

public String getViewHtml(FieldLayoutItem fieldLayoutItem,
                          webwork.action.Action action,
                          Issue issue,
                          Map displayParameters)

Specified by:

getViewHtml in interface OrderableField<List<String>>

getViewHtml

public String getViewHtml(FieldLayoutItem fieldLayoutItem,
                          webwork.action.Action action,
                          Issue issue,
                          List<String> value,
                          Map displayParameters)

Specified by:

getViewHtml in interface OrderableField<List<String>>

availableForBulkEdit

public String availableForBulkEdit(BulkEditBean bulkEditBean)

Description copied from interface: OrderableField

Determines whether the field is available for bulk editing given the BulkEditBean.

Specified by:

availableForBulkEdit in interface OrderableField<List<String>>

Parameters:

bulkEditBean - holds the state of the bulk-edit wizard (e.g. the selected issues for bulk editing)

Returns:

null if the field is available for bulk-editing or an i18n key of the error message to show as why the field is not available.

isShown

public boolean isShown(Issue issue)

Description copied from interface: OrderableField

Tests field specific way to determine if it should be shown or not.

Specified by:

isShown in interface OrderableField<List<String>>

Parameters:

issue - The Issue.

Returns:

true if it should be shown.

populateDefaults

public void populateDefaults(Map<String,Object> fieldValuesHolder,
                             Issue issue)

Description copied from interface: OrderableField

Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.

Specified by:

populateDefaults in interface OrderableField<List<String>>

Parameters:

fieldValuesHolder - The fieldValuesHolder Map to be populated.

issue - The Issue.

populateFromIssue

public void populateFromIssue(Map<String,Object> fieldValuesHolder,
                              Issue issue)

Description copied from interface: OrderableField

Used to initialise the fieldValuesHolder from the current value of teh issue. Used, for example, when showing the Edit Issue screen to show the issue's current values.

Specified by:

populateFromIssue in interface OrderableField<List<String>>

Parameters:

fieldValuesHolder - The fieldValuesHolder Map to be populated.

issue - The Issue.

validateParams

public void validateParams(OperationContext operationContext,
                           ErrorCollection errorCollectionToAddTo,
                           I18nHelper i18n,
                           Issue issue,
                           FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)

Description copied from interface: OrderableField

Ensure that the parameters are valid

Specified by:

validateParams in interface OrderableField<List<String>>

Parameters:

operationContext - OperationContext

errorCollectionToAddTo - ErrorCollection to add to.

i18n - I18nHelper

issue - This is passed to get the value of other fields that may or may not have been modified.

fieldScreenRenderLayoutItem - FieldScreenRenderLayoutItem

getDefaultValue

public List<String> getDefaultValue(Issue issue)

Description copied from interface: OrderableField

The value that should be set on the issue if the field is not shown for some reason.

For example: The user does not have permission to see the field, or the field is not part of the create screen.

Specified by:

getDefaultValue in interface OrderableField<List<String>>

Parameters:

issue - the Issue.

Returns:

The default value. It can be null, or an empty collection.

createValue

public void createValue(Issue issue,
                        List<String> value)

Description copied from interface: OrderableField

Create the value of the issue in the data store.

Specified by:

createValue in interface OrderableField<List<String>>

Parameters:

issue - Issue this field is part of

value - Value to store in this field (eg. Collection for Version fields). Cannot be null.

updateValue

public void updateValue(FieldLayoutItem fieldLayoutItem,
                        Issue issue,
                        ModifiedValue modifiedValue,
                        IssueChangeHolder issueChangeHolder)

Description copied from interface: OrderableField

Update the issue in the data store.

Fields that are simply stored in the JIRAISSUE DB table, need not do anything here as this table is written to one time to include all fields that changed. Fields using other DB tables must update that table with the appropriate values.

Specified by:

updateValue in interface OrderableField<List<String>>

Parameters:

fieldLayoutItem - for this field within this context

issue - Issue this field is part of

modifiedValue - new value to set field to. Cannot be null.

issueChangeHolder - an object to record any changes made to the issue by this method.

updateIssue

public void updateIssue(FieldLayoutItem fieldLayoutItem,
                        MutableIssue issue,
                        Map fieldValueHolder)

Description copied from interface: OrderableField

Record the value on the issue (not saving it to the database, see updateValue).

Specified by:

updateIssue in interface OrderableField<List<String>>

Parameters:

fieldLayoutItem - FieldLayoutItem

issue - MutableIssue

fieldValueHolder - Field Value Holder Map

See Also:

OrderableField.updateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)

needsMove

public MessagedResult needsMove(Collection originalIssues,
                                Issue targetIssue,
                                FieldLayoutItem targetFieldLayoutItem)

Description copied from interface: OrderableField

Used to determine if the field needs input from user to be moved to the new project and/or issue type. This method is called only if the field is visible in the target project/issue type.

Specified by:

needsMove in interface OrderableField<List<String>>

Parameters:

originalIssues - Collection of original Issues.

targetIssue - Nonexistent issue object with values representing those of issue(s) after move

targetFieldLayoutItem - FieldLayoutItem

Returns:

A MessagedResult with result=true if the field needs input to be moved.

populateForMove

public void populateForMove(Map<String,Object> fieldValuesHolder,
                            Issue originalIssue,
                            Issue targetIssue)

Description copied from interface: OrderableField

Used to populate the fieldValueHolder with parameters for move issue screen. This field is only called if the issue needs to be updated during move, i.e. OrderableField.needsMove(java.util.Collection, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem) returned true, and the remote user (the one performing the move) has the permission to actually update this field.

Specified by:

populateForMove in interface OrderableField<List<String>>

Parameters:

fieldValuesHolder - Map of field Values.

originalIssue - orignal Issue

targetIssue - target Issue

removeValueFromIssueObject

public void removeValueFromIssueObject(MutableIssue issue)

Description copied from interface: OrderableField

Removes the field value from the given MutableIssue object.

Note that this operation does not actually persist the change, it just clears the value from the given Issue object. The caller will still need to call #updateValue() in order to persist the change.

Some Fields may choose to quietly ignore this request. eg The SecurityLevel Field will not remove Security Level from subtasks because the subtask must always take the Security Level of its parent issue.

Specified by:

removeValueFromIssueObject in interface OrderableField<List<String>>

Parameters:

issue - The issue object to be effected.

See Also:

OrderableField.canRemoveValueFromIssueObject(com.atlassian.jira.issue.Issue), OrderableField.updateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)

canRemoveValueFromIssueObject

public boolean canRemoveValueFromIssueObject(Issue issue)

Description copied from interface: OrderableField

Returns true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.

There a few different reasons why this method may return false:

• The OrderableField can sometimes remove the value, but it decides that it is not relevant for this Issue. eg: Security Level will ignore remove requests on a subtask, as the subtask Security is not set explicitly (it is always inherited from its parent issue).
• It may possible to remove this value, but the OrderableField does not actually do the job, it is done through some special mechanism. eg Attachments.
• This field is some special system field which it is invalid to remove. eg Project. In these cases calling removeValueFromIssueObject() would normally raise an UnsupportedOperationException.

In general it is safe to call removeValueFromIssueObject() even if this method returns false, as the request will be silently ignored. However there are a couple of special fields where calling removeValueFromIssueObject() will throw an UnsupportedOperationException - eg if you try to remove the Project.

Specified by:

canRemoveValueFromIssueObject in interface OrderableField<List<String>>

Parameters:

issue - The Issue object.

Returns:

true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.

See Also:

OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)

hasValue

public boolean hasValue(Issue issue)

Description copied from interface: OrderableField

Determines if the field has a value for the given issue.

Specified by:

hasValue in interface OrderableField<List<String>>

Parameters:

issue - the Issue.

Returns:

true if the given Issue has a value for this field.

getValueFromParams

public List<String> getValueFromParams(Map params)
                                throws FieldValidationException

Description copied from interface: OrderableField

Get a field value from the map of parameters passed. The params map may contain other parameters that are not relevant to this custom field.

Specified by:

getValueFromParams in interface OrderableField<List<String>>

Parameters:

params - the map of parameters.

Returns:

Value for this field from the map of parameters.

Throws:

FieldValidationException - if there is a problem with Field Validation.

populateParamsFromString

public void populateParamsFromString(Map<String,Object> fieldValuesHolder,
                                     String stringValue,
                                     Issue issue)
                              throws FieldValidationException

Description copied from interface: OrderableField

Used to convert from a user friendly string value and put the result into the fieldValuesHolder. This method is useful for places like Jelly where the field value can be a name (e.g. issue type name) and not a regular id that is used in the web pages.

Specified by:

populateParamsFromString in interface OrderableField<List<String>>

Parameters:

fieldValuesHolder - Map of field Values.

stringValue - user friendly string value

issue - the Issue

Throws:

FieldValidationException - if cannot convert to a value from the given string

getRelevantParams

protected Object getRelevantParams(Map<String,String[]> params)

Specified by:

getRelevantParams in class AbstractOrderableField<List<String>>

getFieldTypeInfo

public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

Description copied from interface: RestAwareField

Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url

Specified by:

getFieldTypeInfo in interface RestAwareField

Parameters:

fieldTypeInfoContext - the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfo

getJsonSchema

public JsonType getJsonSchema()

Description copied from interface: RestAwareField

Return a description of the shape of this field when represented as JSON.

Specified by:

getJsonSchema in interface RestAwareField

getJsonFromIssue

public FieldJsonRepresentation getJsonFromIssue(Issue issue,
                                                boolean renderedVersionRequired,
                                                FieldLayoutItem fieldLayoutItem)

Description copied from interface: RestAwareField

Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

Specified by:

getJsonFromIssue in interface RestAwareField

Parameters:

issue - to get field data from

renderedVersionRequired - whether the use requested the return of rendered/pretty data as well as raw data

fieldLayoutItem - field layout for this field. Will only be supplied if the field is also an ordereable field.

Returns:

FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

getRepresentationFromIssue

public FieldExportParts getRepresentationFromIssue(Issue issue)

This will output a single FieldExportPart with multiple attachment values in it. Each value be in the form: [createdDate;][author;]filename;url for example: {pre} 2012-02-10 12:30:10;wseliga;testfile.txt;url.com/testfile.txt {/pre}

Specified by:

getRepresentationFromIssue in interface ExportableSystemField

Parameters:

issue - to get representation for the field

Returns:

export representation of the field