@PublicApi public interface

OrderableField

implements Field SearchableField
com.atlassian.jira.issue.fields.OrderableField
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Interface for fields in JIRA which are able to be placed on "screens" - once they are on the screen they have an "order". More generally, OrderableFields can be viewed and edited.

Summary

Constants
String MOVE_ISSUE_PARAM_KEY
String NO_HEADER_PARAM_KEY
String TEMPLATE_DIRECTORY_PATH
Public Methods
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 removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.
void createValue(Issue issue, Object value)
Create the value of the issue in the data store.
String getBulkEditHtml(OperationContext operationContext, Action action, BulkEditBean bulkEditBean, Map displayParameters)
Returns HTML that should be shown when the issue is being bulk edited.
String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue)
Returns the HTML that should be shown when the issue is being created.
String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue, Map displayParameters)
Returns the HTML that should be shown when the issue is being created.
Object 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, Action action, Issue issue)
Returns HTML that should be shown when the issue is being edited.
String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue, Map displayParameters)
Returns HTML that should be shown when the issue is being edited.
Object getValueFromParams(Map params)
Get a field value from the map of parameters passed.
String getViewHtml(FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Map displayParameters)
String getViewHtml(FieldLayoutItem fieldLayoutItem, Action action, Issue issue)
String getViewHtml(FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Object value, Map displayParameters)
boolean hasParam(Map<String, String[]> parameters)
Checks to see if the (web) parameters contains a relevant value with which to populate the issue
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 populateFromParams(Map<String, Object> fieldValuesHolder, Map<String, String[]> parameters)
Populate the fieldValuesHolder with a value from (web) parameters.
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
[Expand]
Inherited Methods
From interface com.atlassian.jira.issue.fields.Field
From interface com.atlassian.jira.issue.fields.SearchableField
From interface java.lang.Comparable

Constants

public static final String MOVE_ISSUE_PARAM_KEY

Constant Value: "moveissue"

public static final String NO_HEADER_PARAM_KEY

Constant Value: "noHeader"

public static final String TEMPLATE_DIRECTORY_PATH

Constant Value: "templates/jira/issue/field/"

Public Methods

public String availableForBulkEdit (BulkEditBean bulkEditBean)

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

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.

public boolean canRemoveValueFromIssueObject (Issue issue)

Returns true if a call to 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.

Parameters
issue The Issue object.
Returns
See Also

public void createValue (Issue issue, Object value)

Create the value of the issue in the data store.

Parameters
issue Issue this field is part of
value Value to store in this field (eg. Collection for Version fields). Cannot be null.

public String getBulkEditHtml (OperationContext operationContext, Action action, BulkEditBean bulkEditBean, Map displayParameters)

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

Parameters
operationContext OperationContext
action Action
bulkEditBean BulkEditBean
displayParameters Map of display parameters.
Returns
  • HTML that should be shown when the issue is being edited.

public String getCreateHtml (FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue)

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

Parameters
fieldLayoutItem FieldLayoutItem
operationContext OperationContext
action Action
issue Issue
Returns
  • the HTML that should be shown when the issue is being created.

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

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

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.

public Object getDefaultValue (Issue issue)

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.

Parameters
issue the Issue.
Returns
  • The default Value.

public String getEditHtml (FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue)

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

Parameters
fieldLayoutItem FieldLayoutItem
operationContext OperationContext
action Action
issue Issue
Returns
  • HTML that should be shown when the issue is being edited.

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

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

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.

public Object getValueFromParams (Map params)

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.

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.

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

public String getViewHtml (FieldLayoutItem fieldLayoutItem, Action action, Issue issue)

public String getViewHtml (FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Object value, Map displayParameters)

public boolean hasParam (Map<String, String[]> parameters)

Checks to see if the (web) parameters contains a relevant value with which to populate the issue

Parameters
parameters Map of HTTP request parameters ("Action parameters").

public boolean hasValue (Issue issue)

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

Parameters
issue the Issue.
Returns
  • true if the given Issue has a value for this field.

public boolean isShown (Issue issue)

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

Parameters
issue The Issue.
Returns
  • true if it should be shown.

public 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. This method is called only if the field is visible in the target project/issue type.

Parameters
originalIssues Collection of original Issues.
targetIssue Target Issue.
targetFieldLayoutItem FieldLayoutItem
Returns
  • A MessagedResult with result=true if the field needs input to be moved.

public 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.

Parameters
fieldValuesHolder The fieldValuesHolder Map to be populated.
issue The Issue.

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

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. 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.

Parameters
fieldValuesHolder Map of field Values.
originalIssue orignal Issue
targetIssue target Issue

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

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.

Parameters
fieldValuesHolder The fieldValuesHolder Map to be populated.
issue The Issue.

public void populateFromParams (Map<String, Object> fieldValuesHolder, Map<String, String[]> parameters)

Populate the fieldValuesHolder with a value from (web) parameters.

Parameters
fieldValuesHolder The fieldValuesHolder Map to be populated.
parameters Map of HTTP parameters.

public 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. 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.

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

public void removeValueFromIssueObject (MutableIssue issue)

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.

Parameters
issue The issue object to be effected.
See Also

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

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

Parameters
fieldLayoutItem FieldLayoutItem
issue MutableIssue
fieldValueHolder Field Value Holder Map
See Also

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

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.

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.

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

Ensure that the parameters are valid

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