com.atlassian.jira.issue.fields
Class SummarySystemField

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.AbstractTextSystemField
                  com.atlassian.jira.issue.fields.SummarySystemField

All Implemented Interfaces:

Comparable, Field, MandatoryField, NavigableField, OrderableField, RenderableField, SearchableField

public class SummarySystemField

extends AbstractTextSystemField

implements NavigableField, MandatoryField

Copyright (c) 2002-2004 All rights reserved.

Field Summary

static Long

MAX_LEN

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

authenticationContext

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

ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH

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

MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH

Constructor Summary

SummarySystemField(com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, SubTaskManager subTaskManager, IssueManager issueManager, JiraAuthenticationContext authenticationContext, RendererManager rendererManager, PermissionManager permissionManager)

Method Summary

String	availableForBulkEdit(BulkEditBean bulkEditBean) Determines whether the field is available for bulk editing given the BulkEditBean.
List	getAssociatedSearchers() Returns a list of searchers associated with field
String	getColumnHeadingKey()
protected String	getColumnViewTemplateName()
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.
protected String	getEditTemplateName()
LuceneFieldSorter	getSorter() A sorter to be used when sorting columns in a table.
String	getValueFromIssue(Issue issue) Gets the value stored for this field on the provided issue.
boolean	isRenderable() Defines if a field determines itself as renderable.
boolean	isShown(Issue issue) Tests field specific way to determine if it should be shown or not
void	populateFromIssue(Map fieldValuesHolder, Issue issue) Used to initialise the fieldValuesHolder from the current value of teh issue.
protected void	populateVelocityParams(FieldLayoutItem fieldLayoutItem, Issue issue, Map params)
protected void	populateVelocityParams(org.ofbiz.core.entity.GenericValue issue, Map params)
protected void	populateVelocityParams(Map fieldValuesHolder, Map params)
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	validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) validate the field value

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

createValue, getChangeLogFieldName, getChangelogValue, getColumnViewHtml, getCreateHtml, getEditHtml, getRelevantParams, getValueFromParams, getViewHtml, getViewHtml, hasValue, needsMove, populateDefaults, populateForMove, populateParamsFromString, updateValue, valuesEqual

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

getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory

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

getApplicationProperties, getBulkEditHtml, 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.NavigableField

getColumnCssClass, getColumnViewHtml, getHiddenFieldId, getSortComparatorSource, prettyPrintChangeHistory, prettyPrintChangeHistory

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

getId, getName, getNameKey

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.atlassian.jira.issue.fields.renderer.RenderableField

getId

Field Detail

MAX_LEN

public static final Long MAX_LEN

Constructor Detail

SummarySystemField

public SummarySystemField(com.atlassian.velocity.VelocityManager velocityManager,
                          ApplicationProperties applicationProperties,
                          SubTaskManager subTaskManager,
                          IssueManager issueManager,
                          JiraAuthenticationContext authenticationContext,
                          RendererManager rendererManager,
                          PermissionManager permissionManager)

Method Detail

populateVelocityParams

protected void populateVelocityParams(org.ofbiz.core.entity.GenericValue issue,
                                      Map params)

getEditTemplateName

protected String getEditTemplateName()

Specified by:

getEditTemplateName in class AbstractTextSystemField

getColumnViewTemplateName

protected String getColumnViewTemplateName()

Specified by:

getColumnViewTemplateName in class AbstractTextSystemField

populateVelocityParams

protected void populateVelocityParams(Map fieldValuesHolder,
                                      Map params)

Overrides:

populateVelocityParams in class AbstractTextSystemField

populateVelocityParams

protected void populateVelocityParams(FieldLayoutItem fieldLayoutItem,
                                      Issue issue,
                                      Map params)

Overrides:

populateVelocityParams in class AbstractTextSystemField

getValueFromIssue

public String getValueFromIssue(Issue issue)

Description copied from interface: RenderableField

Gets the value stored for this field on the provided issue.

Specified by:

getValueFromIssue in interface RenderableField

Specified by:

getValueFromIssue in class AbstractTextSystemField

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 -

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

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

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

Overrides:

populateFromIssue in class AbstractTextSystemField

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

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

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 -

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

isRenderable

public boolean isRenderable()

Description copied from interface: RenderableField

Defines if a field determines itself as renderable. This is needed because of the way that customfields are implemented. Since all the real work is done in CustomFieldTypes, if we want to treat system fields and custom fields the same way in the renderers then all custom fields must implement this interface. We therefore provide this method so that the CustomFieldImpl can delegate to the CustomFieldTypes to determine if a given custom field is renderable.

Specified by:

isRenderable in interface RenderableField

Overrides:

isRenderable in class AbstractTextSystemField

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.