com.atlassian.jira.issue.fields
Class AffectedVersionsSystemField

java.lang.Object
  extended by com.atlassian.jira.issue.fields.AbstractField
      extended by com.atlassian.jira.issue.fields.AbstractOrderableField
          extended by com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl
              extended by com.atlassian.jira.issue.fields.AbstractVersionsSystemField
                  extended by com.atlassian.jira.issue.fields.AffectedVersionsSystemField
All Implemented Interfaces:
AffectedVersionsField, Field, HideableField, NavigableField, OrderableField, RequirableField, RestAwareField, RestFieldOperations, SearchableField, Comparable

public class AffectedVersionsSystemField
extends AbstractVersionsSystemField
implements AffectedVersionsField, RestFieldOperations

Copyright (c) 2002-2004 All rights reserved.


Field Summary
 
Fields inherited from class com.atlassian.jira.issue.fields.AbstractVersionsSystemField
RELEASED_VERSION_ID, UNKNOWN_VERSION_ID, UNRELEASED_VERSION_ID, versionManager
 
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
AffectedVersionsSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, VersionManager versionManager, PermissionManager permissionManager, JiraAuthenticationContext authenticationContext, RaisedInVersionStatisticsMapper raisedInVersionStatsMapper, VersionHelperBean versionHelperBean, AffectedVersionSearchHandlerFactory searchHandlerFactory, JiraBaseUrls jiraBaseUrls)
           
 
Method Summary
protected  void addFieldRequiredErrorMessage(Issue issue, ErrorCollection errorCollection, I18nHelper i18n)
           
 boolean canRemoveValueFromIssueObject(Issue issue)
          Returns true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.
protected  String getArchivedVersionsFieldSearchParam()
           
protected  String getArchivedVersionsFieldTitle()
           
protected  String getChangeItemFieldName()
           
 String getColumnHeadingKey()
           
protected  Collection<Version> getCurrentVersions(Issue issue)
           
 Object getDefaultValue(Issue issue)
          The value that should be set on the issue if the field is not shown for some reason.
protected  String getIssueRelationName()
           
 JsonData getJsonDefaultValue(IssueContext issueCtx)
          Return The default data for this system field.
protected  String getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)
           
 RestFieldOperationsHandler getRestFieldOperation()
           
 LuceneFieldSorter getSorter()
          A sorter to be used when sorting columns in a table.
protected  boolean getUnreleasedVersionsFirst()
           
 boolean isShown(Issue issue)
          Tests field specific way to determine if it should be shown or not.
 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).
 
Methods inherited from class com.atlassian.jira.issue.fields.AbstractVersionsSystemField
addViewVelocityParams, availableForBulkEdit, createValue, getBulkEditHtml, getColumnViewHtml, getCreateHtml, getCurrentVersionIds, getDefaultSortOrder, getEditHtml, getFieldTypeInfo, getJsonFromIssue, getJsonSchema, getPossibleVersions, getRelevantParams, getValueFromParams, getVersionManager, getViewHtml, getViewHtml, hasValue, needsMove, populateDefaults, populateForMove, populateFromIssue, populateParamsFromString, updateValue, validateParams
 
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl
getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getSortFields, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory
 
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField
createAssociatedSearchHandler, getApplicationProperties, getCreateHtml, getEditHtml, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, 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, getDefaultSortOrder, getHiddenFieldId, getSortComparatorSource, getSortFields, prettyPrintChangeHistory, prettyPrintChangeHistory
 
Methods inherited from interface com.atlassian.jira.issue.fields.OrderableField
availableForBulkEdit, createValue, getBulkEditHtml, getCreateHtml, getCreateHtml, getEditHtml, getEditHtml, getValueFromParams, getViewHtml, getViewHtml, getViewHtml, hasParam, hasValue, needsMove, populateDefaults, populateForMove, populateFromIssue, populateFromParams, populateParamsFromString, updateValue, validateParams
 
Methods inherited from interface com.atlassian.jira.issue.fields.SearchableField
createAssociatedSearchHandler
 
Methods inherited from interface com.atlassian.jira.issue.fields.Field
getId, getName, getNameKey
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

AffectedVersionsSystemField

public AffectedVersionsSystemField(VelocityTemplatingEngine templatingEngine,
                                   ApplicationProperties applicationProperties,
                                   VersionManager versionManager,
                                   PermissionManager permissionManager,
                                   JiraAuthenticationContext authenticationContext,
                                   RaisedInVersionStatisticsMapper raisedInVersionStatsMapper,
                                   VersionHelperBean versionHelperBean,
                                   AffectedVersionSearchHandlerFactory searchHandlerFactory,
                                   JiraBaseUrls jiraBaseUrls)
Method Detail

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
Parameters:
issue - The Issue.
Returns:
true if it should be shown.

getCurrentVersions

protected Collection<Version> getCurrentVersions(Issue issue)
Specified by:
getCurrentVersions in class AbstractVersionsSystemField

getArchivedVersionsFieldTitle

protected String getArchivedVersionsFieldTitle()
Specified by:
getArchivedVersionsFieldTitle in class AbstractVersionsSystemField

getArchivedVersionsFieldSearchParam

protected String getArchivedVersionsFieldSearchParam()
Specified by:
getArchivedVersionsFieldSearchParam in class AbstractVersionsSystemField

getUnreleasedVersionsFirst

protected boolean getUnreleasedVersionsFirst()
Specified by:
getUnreleasedVersionsFirst in class AbstractVersionsSystemField

addFieldRequiredErrorMessage

protected void addFieldRequiredErrorMessage(Issue issue,
                                            ErrorCollection errorCollection,
                                            I18nHelper i18n)
Specified by:
addFieldRequiredErrorMessage in class AbstractVersionsSystemField

getColumnHeadingKey

public String getColumnHeadingKey()
Specified by:
getColumnHeadingKey in interface NavigableField

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

getIssueRelationName

protected String getIssueRelationName()
Specified by:
getIssueRelationName in class AbstractVersionsSystemField

getChangeItemFieldName

protected String getChangeItemFieldName()
Specified by:
getChangeItemFieldName in class AbstractVersionsSystemField

getModifiedWithoutPermissionErrorMessage

protected String getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)
Specified by:
getModifiedWithoutPermissionErrorMessage in class AbstractVersionsSystemField

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
Overrides:
getDefaultValue in class AbstractVersionsSystemField
Parameters:
issue - the Issue.
Returns:
The default Value.

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

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

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

getRestFieldOperation

public RestFieldOperationsHandler getRestFieldOperation()
Specified by:
getRestFieldOperation in interface RestFieldOperations
Returns:
the RestFieldOperationsHandler for this field.

getJsonDefaultValue

public JsonData getJsonDefaultValue(IssueContext issueCtx)
Description copied from interface: RestFieldOperations
Return The default data for this system field. May be null if there is no default.

Specified by:
getJsonDefaultValue in interface RestFieldOperations
Parameters:
issueCtx - Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.


Copyright © 2002-2013 Atlassian. All Rights Reserved.