com.atlassian.jira.issue.fields
Interface OrderableField

All Superinterfaces:

Comparable, Field, SearchableField

All Known Subinterfaces:

ConfigurableField, CustomField, DependentField

All Known Implementing Classes:

AbstractOrderableField, AbstractOrderableNavigableFieldImpl, AbstractTextSystemField, AbstractVersionsSystemField, AffectedVersionsSystemField, AssigneeSystemField, AttachmentSystemField, CommentSystemField, ComponentsSystemField, CustomFieldImpl, DescriptionSystemField, DueDateSystemField, EnvironmentSystemField, FixVersionsSystemField, IssueTypeSystemField, PrioritySystemField, ProjectSystemField, ReporterSystemField, ResolutionSystemField, SecurityLevelSystemField, SummarySystemField, TimeTrackingSystemField

public interface OrderableField
extends Field, SearchableField

Field Summary

static String	MOVE_ISSUE_PARAM_KEY
static String	NO_HEADER_PARAM_KEY
static String	TEMPLATE_DIRECTORY_PATH

Method Summary

String	availableForBulkEdit(BulkEditBean bulkEditBean) Determines whether the field is available for bulk editing given the BulkEditBean.
void	createValue(Issue issue, Object value) Create the value of the issue in the data store.
String	getBulkEditHtml(OperationContext operationContext, webwork.action.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, webwork.action.Action action, Issue issue) Returns the HTML that should be shown when the issue is being created
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
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, webwork.action.Action action, Issue issue) Returns HTML that should be shown when the issue is being edited
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
Object	getValueFromParams(Map params) Get a field value from the map of parameters passed.
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue)
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Object value, 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 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 fieldValuesHolder, Issue originalIssue, Issue targetIssue) Used to populate the fieldValueHolder with parameters for move issue screen.
void	populateFromIssue(Map fieldValuesHolder, Issue issue) Used to initialise the fieldValuesHolder from the current value of teh issue.
void	populateFromParams(Map fieldValuesHolder, Map parameters) Populate the fieldValuesHolder with a value from (web) parameters
void	populateParamsFromString(Map fieldValuesHolder, String stringValue, Issue issue) Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
void	removeValue(MutableIssue issue) Removes the value for the given issue.
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 interface com.atlassian.jira.issue.fields.SearchableField

getAssociatedSearchers

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

getId, getName, getNameKey

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

TEMPLATE_DIRECTORY_PATH

static final String TEMPLATE_DIRECTORY_PATH

See Also:

Constant Field Values

MOVE_ISSUE_PARAM_KEY

static final String MOVE_ISSUE_PARAM_KEY

See Also:

Constant Field Values

NO_HEADER_PARAM_KEY

static final String NO_HEADER_PARAM_KEY

See Also:

Constant Field Values

Method Detail

getCreateHtml

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

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

getCreateHtml

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

getEditHtml

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

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

getEditHtml

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

getBulkEditHtml

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

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

getViewHtml

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

getViewHtml

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

getViewHtml

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

isShown

boolean isShown(Issue issue)

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

populateDefaults

void populateDefaults(Map fieldValuesHolder,
                      Issue issue)

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

populateFromParams

void populateFromParams(Map fieldValuesHolder,
                        Map parameters)

Populate the fieldValuesHolder with a value from (web) parameters

populateFromIssue

void populateFromIssue(Map fieldValuesHolder,
                       Issue issue)

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

validateParams

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

Ensure that the parameters are valid

Parameters:

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

fieldScreenRenderLayoutItem -

getDefaultValue

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 -

createValue

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.

updateValue

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

Update the issue in the data store

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

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

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

Parameters:

fieldLayoutItem -

issue -

fieldValueHolder -

needsMove

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.

populateForMove

void populateForMove(Map 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.

removeValue

void removeValue(MutableIssue issue)

Removes the value for the given issue. Returns a list of change items for the removed value.

hasValue

boolean hasValue(Issue issue)

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

availableForBulkEdit

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.

getValueFromParams

Object getValueFromParams(Map params)
                          throws FieldValidationException

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.

Throws:

FieldValidationException

populateParamsFromString

void populateParamsFromString(Map fieldValuesHolder,
                              String stringValue,
                              Issue issue)
                              throws FieldValidationException

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.

Throws:

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