com.atlassian.jira.issue.fields
Class IssueTypeSystemField

java.lang.Object
  com.atlassian.jira.issue.fields.AbstractField
      com.atlassian.jira.issue.fields.AbstractOrderableField
          com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl
              com.atlassian.jira.issue.fields.IssueTypeSystemField

All Implemented Interfaces:

Comparable, ConfigurableField, DependentField, Field, IssueConstantsField, MandatoryField, NavigableField, OrderableField, SearchableField

public class IssueTypeSystemField

extends AbstractOrderableNavigableFieldImpl

implements ConfigurableField, DependentField, MandatoryField, IssueConstantsField

Copyright (c) 2002-2004 All rights reserved.

Field Summary

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

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

ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH

Constructor Summary

IssueTypeSystemField(com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, ConstantsManager constantsManager, WorkflowManager workflowManager, PermissionManager permissionManager, IssueTypeStatisticsMapper issueTypeStatisticsMapper, FieldConfigSchemeManager fieldConfigSchemeManager, OptionSetManager optionSetManager, IssueTypeSchemeManager issueTypeSchemeManager)

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.
List	getAssociatedProjects()
List	getAssociatedSearchers() Returns a list of searchers associated with field
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	getColumnHeadingKey()
String	getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
List	getConfigurationItemTypes() Returns a List of FieldConfigItemType objects.
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
String	getDefaultSortOrder() The order in which to sort the field when it is sorted for the first time.
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, Map displayParameters) Returns HTML that should be shown when the issue is being edited
String	getEditHtml(OperationContext operationContext, webwork.action.Action action, List options)
Collection	getIssueConstants()
Collection	getOptionsForIssue(Issue issue, boolean isSubTask)
Field	getParentField()
FieldConfig	getRelevantConfig(IssueContext issueContext)
protected Object	getRelevantParams(Map params)
LuceneFieldSorter	getSorter() A sorter to be used when sorting columns in a table.
Object	getValueFromParams(Map params) Get a field value from the map of parameters passed.
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	isHasCommonIssueTypes(Collection selectedIssues) This method will determine if there are ANY issue type that the selectedIssues have in common.
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	populateParamsFromString(Map fieldValuesHolder, String stringValue, Issue issue) Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
String	prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper) Return an internationalized value for the changeHistory item - an issue type name in this case.
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) validate the field value

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

getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getVelocityParams, prettyPrintChangeHistory

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

getApplicationProperties, getCreateHtml, getEditHtml, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, 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.OrderableField

getCreateHtml, getEditHtml, getViewHtml, populateFromParams

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

getId, getName, getNameKey

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

IssueTypeSystemField

public IssueTypeSystemField(com.atlassian.velocity.VelocityManager velocityManager,
                            ApplicationProperties applicationProperties,
                            JiraAuthenticationContext authenticationContext,
                            ConstantsManager constantsManager,
                            WorkflowManager workflowManager,
                            PermissionManager permissionManager,
                            IssueTypeStatisticsMapper issueTypeStatisticsMapper,
                            FieldConfigSchemeManager fieldConfigSchemeManager,
                            OptionSetManager optionSetManager,
                            IssueTypeSchemeManager issueTypeSchemeManager)

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

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

getBulkEditHtml

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

Description copied from interface: OrderableField

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

Specified by:

getBulkEditHtml in interface OrderableField

Overrides:

getBulkEditHtml in class AbstractOrderableField

getEditHtml

public String getEditHtml(OperationContext operationContext,
                          webwork.action.Action action,
                          List options)

getViewHtml

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

Specified by:

getViewHtml in interface OrderableField

getViewHtml

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

Specified by:

getViewHtml in interface OrderableField

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

populateDefaults

public void populateDefaults(Map 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

getDefaultValue

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

Parameters:

issue -

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

Parameters:

fieldLayoutItem -

issue -

fieldValueHolder -

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

populateForMove

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

removeValue

public void removeValue(MutableIssue issue)

Description copied from interface: OrderableField

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

Specified by:

removeValue in interface OrderableField

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

validateParams

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

validate the field value

Specified by:

validateParams in interface OrderableField

Parameters:

operationContext -

errorCollectionToAddTo -

fieldScreenRenderLayoutItem -

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

getValueFromParams

public Object getValueFromParams(Map params)

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

populateParamsFromString

public void populateParamsFromString(Map 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

Throws:

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

getAssociatedSearchers

public List getAssociatedSearchers()

Description copied from interface: SearchableField

Returns a list of searchers associated with field

Specified by:

getAssociatedSearchers in interface SearchableField

Returns:

List of @Class objects of type @IssueSearcher. Empty list if no searchers are required. Must not be null

createValue

public void createValue(Issue issue,
                        Object value)

Description copied from interface: OrderableField

Create the value of the issue in the data store.

Specified by:

createValue in interface OrderableField

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

Specified by:

updateValue in interface OrderableField

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.

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

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.

isHasCommonIssueTypes

public boolean isHasCommonIssueTypes(Collection selectedIssues)

This method will determine if there are ANY issue type that the selectedIssues have in common. This takes into account the possible difference in workflow or field configuration for each issue type.

Parameters:

selectedIssues -

Returns:

true if there are issue types in common, false otherwise

getRelevantParams

protected Object getRelevantParams(Map params)

Specified by:

getRelevantParams in class AbstractOrderableField

populateFromIssue

public void populateFromIssue(Map 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 teh Edit Issue screen to show the issue's current values.

Specified by:

populateFromIssue in interface OrderableField

getColumnHeadingKey

public String getColumnHeadingKey()

Specified by:

getColumnHeadingKey in interface NavigableField

getDefaultSortOrder

public String getDefaultSortOrder()

Description copied from interface: NavigableField

The order in which to sort the field when it is sorted for the first time.

Specified by:

getDefaultSortOrder in interface NavigableField

Returns:

Either NavigableField.ORDER_ASCENDING or NavigableField.ORDER_DESCENDING

getSorter

public LuceneFieldSorter getSorter()

Description copied from interface: NavigableField

A sorter to be used when sorting columns in a table. This sort uses the Lucene Document Collection and is therefore a lot faster than sorting the issues in memory.

Specified by:

getSorter in interface NavigableField

Returns:

A sorter that can be used to sort this field, or null depending on the value of NavigableField.getSortComparatorSource()

See Also:

DocumentIssueImpl, MappedSortComparator

getColumnViewHtml

public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
                                Map displayParams,
                                Issue issue)

Specified by:

getColumnViewHtml in interface NavigableField

getOptionsForIssue

public Collection getOptionsForIssue(Issue issue,
                                     boolean isSubTask)

getConfigurationItemTypes

public List getConfigurationItemTypes()

Description copied from interface: ConfigurableField

Returns a List of FieldConfigItemType objects. This opens up possibilties for configurable custom fields

Specified by:

getConfigurationItemTypes in interface ConfigurableField

Returns:

List of FieldConfigItemType @NotNull

getAssociatedProjects

public List getAssociatedProjects()

Specified by:

getAssociatedProjects in interface ConfigurableField

getRelevantConfig

public FieldConfig getRelevantConfig(IssueContext issueContext)

Specified by:

getRelevantConfig in interface ConfigurableField

getParentField

public Field getParentField()

Specified by:

getParentField in interface DependentField

getIssueConstants

public Collection getIssueConstants()

Specified by:

getIssueConstants in interface IssueConstantsField

prettyPrintChangeHistory

public String prettyPrintChangeHistory(String changeHistory,
                                       I18nHelper i18nHelper)

Return an internationalized value for the changeHistory item - an issue type name in this case.

Specified by:

prettyPrintChangeHistory in interface NavigableField

Overrides:

prettyPrintChangeHistory in class AbstractOrderableNavigableFieldImpl

Parameters:

changeHistory - name of issue type

i18nHelper - used to translate the issue type name

Returns:

String