com.atlassian.jira.issue.fields
Class AbstractVersionsSystemField

java.lang.Object
  extended bycom.atlassian.jira.issue.fields.AbstractField
      extended bycom.atlassian.jira.issue.fields.AbstractOrderableField
          extended bycom.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl
              extended bycom.atlassian.jira.issue.fields.AbstractVersionsSystemField
All Implemented Interfaces:
Comparable, Field, HideableField, NavigableField, OrderableField, RequirableField, SearchableField
Direct Known Subclasses:
AffectedVersionsSystemField, FixVersionsSystemField

public abstract class AbstractVersionsSystemField
extends AbstractOrderableNavigableFieldImpl
implements HideableField, RequirableField

Copyright (c) 2002-2004 All rights reserved.


Field Summary
static Long RELEASED_VERSION_ID
           
static Long UNKNOWN_VERSION_ID
           
static Long UNRELEASED_VERSION_ID
           
 
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
AbstractVersionsSystemField(String id, String name, com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, VersionManager versionManager, PermissionManager permissionManager, JiraAuthenticationContext authenticationContext, VersionHelperBean versionHelperBean)
           
 
Method Summary
protected abstract  void addFieldRequiredErrorMessage(Issue issue, ErrorCollection errorCollectionToAddTo, I18nHelper i18n)
           
 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.
protected abstract  String getArchivedVersionsFieldSearchParam()
           
protected abstract  String getArchivedVersionsFieldTitle()
           
protected abstract  String getChangeItemFieldName()
           
 String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
           
 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
protected  Collection getCurrentVersionIds(Issue issue)
           
protected abstract  Collection getCurrentVersions(Issue issue)
           
 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
protected abstract  String getIssueRelationName()
           
protected abstract  String getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)
           
protected  List getPossibleVersions(org.ofbiz.core.entity.GenericValue project, boolean unreleasedFirst)
           
protected  Object getRelevantParams(Map params)
           
protected abstract  boolean getUnreleasedVersionsFirst()
           
 Object getValueFromParams(Map params)
          Get a field value from the map of parameters passed.
protected  VersionManager getVersionManager()
           
 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.
 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 params, 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.
 void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
          Update the issue in the data store
 void validateParams(OperationContext operationContext, ErrorCollection errorCollection, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
          Ensure that the parameters are valid
 
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.Field
getId, getName, getNameKey
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface com.atlassian.jira.issue.fields.NavigableField
getColumnHeadingKey, getSorter
 
Methods inherited from interface com.atlassian.jira.issue.fields.OrderableField
isShown, removeValue, updateIssue
 
Methods inherited from interface com.atlassian.jira.issue.fields.SearchableField
getAssociatedSearchers
 

Field Detail

UNKNOWN_VERSION_ID

public static final Long UNKNOWN_VERSION_ID

UNRELEASED_VERSION_ID

public static final Long UNRELEASED_VERSION_ID

RELEASED_VERSION_ID

public static final Long RELEASED_VERSION_ID
Constructor Detail

AbstractVersionsSystemField

public AbstractVersionsSystemField(String id,
                                   String name,
                                   com.atlassian.velocity.VelocityManager velocityManager,
                                   ApplicationProperties applicationProperties,
                                   VersionManager versionManager,
                                   PermissionManager permissionManager,
                                   JiraAuthenticationContext authenticationContext,
                                   VersionHelperBean versionHelperBean)
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

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

getRelevantParams

protected Object getRelevantParams(Map params)
Specified by:
getRelevantParams in class AbstractOrderableField

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

populateFromIssue

public void populateFromIssue(Map params,
                              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

getCurrentVersionIds

protected Collection getCurrentVersionIds(Issue issue)

getCurrentVersions

protected abstract Collection getCurrentVersions(Issue issue)

getArchivedVersionsFieldTitle

protected abstract String getArchivedVersionsFieldTitle()

getArchivedVersionsFieldSearchParam

protected abstract String getArchivedVersionsFieldSearchParam()

getUnreleasedVersionsFirst

protected abstract boolean getUnreleasedVersionsFirst()

getPossibleVersions

protected List getPossibleVersions(org.ofbiz.core.entity.GenericValue project,
                                   boolean unreleasedFirst)

validateParams

public void validateParams(OperationContext operationContext,
                           ErrorCollection errorCollection,
                           I18nHelper i18n,
                           Issue issue,
                           FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
Description copied from interface: OrderableField
Ensure that the parameters are valid

Specified by:
validateParams in interface OrderableField
Parameters:
issue - this is passed to get the value of other fields that may or may not have been modified
fieldScreenRenderLayoutItem -

addFieldRequiredErrorMessage

protected abstract void addFieldRequiredErrorMessage(Issue issue,
                                                     ErrorCollection errorCollectionToAddTo,
                                                     I18nHelper i18n)

getModifiedWithoutPermissionErrorMessage

protected abstract String getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)

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.

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

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

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.

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 -

getChangeItemFieldName

protected abstract String getChangeItemFieldName()

getIssueRelationName

protected abstract String getIssueRelationName()

getVersionManager

protected VersionManager getVersionManager()

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

getColumnViewHtml

public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
                                Map displayParams,
                                Issue issue)
Specified by:
getColumnViewHtml in interface NavigableField

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.


Copyright © 2002-2006 Atlassian. All Rights Reserved.