com.atlassian.jira.issue.fields
Class DueDateSystemField

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.DueDateSystemField
All Implemented Interfaces:
DateField, Field, HideableField, NavigableField, OrderableField, RequirableField, SearchableField, java.lang.Comparable

public class DueDateSystemField
extends AbstractOrderableNavigableFieldImpl
implements HideableField, RequirableField, DateField


Field Summary
 
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
DueDateSystemField(com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, PermissionManager permissionManager, JiraAuthenticationContext authenticationContext, OutlookDateManager outlookDateManager, DueDateSearchHandlerFactory factory)
           
 
Method Summary
 java.lang.String availableForBulkEdit(BulkEditBean bulkEditBean)
          Determines whether the field is available for bulk editing given the BulkEditBean.
 boolean canRemoveValueFromIssueObject(Issue issue)
          Returns true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.
 void createValue(Issue issue, java.lang.Object value)
          Create the value of the issue in the data store.
 java.lang.String getColumnHeadingKey()
           
 java.lang.String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, java.util.Map displayParams, Issue issue)
           
 java.lang.String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, java.util.Map dispayParameters)
          Returns the HTML that should be shown when the issue is being created.
 java.lang.String getDefaultSortOrder()
          The order in which to sort the field when it is sorted for the first time.
 java.lang.Object getDefaultValue(Issue issue)
          The value that should be set on the issue if the field is not shown for some reason.
 java.lang.String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, java.util.Map displayParameters)
          Returns HTML that should be shown when the issue is being edited.
protected  java.lang.Object getRelevantParams(java.util.Map params)
           
 LuceneFieldSorter getSorter()
          A sorter to be used when sorting columns in a table.
 java.lang.Object getValueFromParams(java.util.Map params)
          Get a field value from the map of parameters passed.
 java.lang.String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, java.util.Map displayParameters)
           
 java.lang.String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, java.lang.Object value, java.util.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(java.util.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(java.util.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(java.util.Map fieldValuesHolder, Issue originalIssue, Issue targetIssue)
          Used to populate the fieldValueHolder with parameters for move issue screen.
 void populateFromIssue(java.util.Map fieldValuesHolder, Issue issue)
          Used to initialise the fieldValuesHolder from the current value of teh issue.
 void populateParamsFromString(java.util.Map fieldValuesHolder, java.lang.String stringValue, Issue issue)
          Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
 java.lang.String prettyPrintChangeHistory(java.lang.String changeHistory)
           
 java.lang.String prettyPrintChangeHistory(java.lang.String changeHistory, I18nHelper i18nHelper)
          Used for email notification templates - allows changelog to be displayed in language of the recipient.
 void removeValueFromIssueObject(MutableIssue issue)
          Removes the field value from the given MutableIssue object.
 void updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, java.util.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
 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
 
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField
createAssociatedSearchHandler, 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
 

Constructor Detail

DueDateSystemField

public DueDateSystemField(com.atlassian.velocity.VelocityManager velocityManager,
                          ApplicationProperties applicationProperties,
                          PermissionManager permissionManager,
                          JiraAuthenticationContext authenticationContext,
                          OutlookDateManager outlookDateManager,
                          DueDateSearchHandlerFactory factory)
Method Detail

getCreateHtml

public java.lang.String getCreateHtml(FieldLayoutItem fieldLayoutItem,
                                      OperationContext operationContext,
                                      webwork.action.Action action,
                                      Issue issue,
                                      java.util.Map dispayParameters)
Description copied from interface: OrderableField
Returns the HTML that should be shown when the issue is being created.

Specified by:
getCreateHtml in interface OrderableField
Parameters:
fieldLayoutItem - FieldLayoutItem
operationContext - OperationContext
action - Action
issue - Issue
dispayParameters - Map of display parameters.
Returns:
the HTML that should be shown when the issue is being created.

getEditHtml

public java.lang.String getEditHtml(FieldLayoutItem fieldLayoutItem,
                                    OperationContext operationContext,
                                    webwork.action.Action action,
                                    Issue issue,
                                    java.util.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
Parameters:
fieldLayoutItem - FieldLayoutItem
operationContext - OperationContext
action - Action
issue - Issue
displayParameters - Map of display parameters.
Returns:
HTML that should be shown when the issue is being edited.

getViewHtml

public java.lang.String getViewHtml(FieldLayoutItem fieldLayoutItem,
                                    webwork.action.Action action,
                                    Issue issue,
                                    java.util.Map displayParameters)
Specified by:
getViewHtml in interface OrderableField

getViewHtml

public java.lang.String getViewHtml(FieldLayoutItem fieldLayoutItem,
                                    webwork.action.Action action,
                                    Issue issue,
                                    java.lang.Object value,
                                    java.util.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
Parameters:
issue - The Issue.
Returns:
true if it should be shown.

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:
operationContext - OperationContext
errorCollection - ErrorCollection to add to.
i18n - I18nHelper
issue - This is passed to get the value of other fields that may or may not have been modified.
fieldScreenRenderLayoutItem - FieldScreenRenderLayoutItem

createValue

public void createValue(Issue issue,
                        java.lang.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)
Update the issue

Specified by:
updateValue in interface OrderableField
Parameters:
fieldLayoutItem -
issue -
issueChangeHolder -
modifiedValue - new value to set field to. Cannot be null.

getValueFromParams

public java.lang.Object getValueFromParams(java.util.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
Parameters:
params - the map of parameters.
Returns:
Value for this field from the map of parameters.

populateParamsFromString

public void populateParamsFromString(java.util.Map fieldValuesHolder,
                                     java.lang.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
Parameters:
fieldValuesHolder - Map of field Values.
stringValue - user friendly string value
issue - the Issue
Throws:
FieldValidationException - if cannot convert to a value from the given string

availableForBulkEdit

public java.lang.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.

getRelevantParams

protected java.lang.Object getRelevantParams(java.util.Map params)
Specified by:
getRelevantParams in class AbstractOrderableField

populateFromIssue

public void populateFromIssue(java.util.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
Parameters:
fieldValuesHolder - The fieldValuesHolder Map to be populated.
issue - The Issue.

populateDefaults

public void populateDefaults(java.util.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
Parameters:
fieldValuesHolder - The fieldValuesHolder Map to be populated.
issue - The Issue.

getDefaultValue

public java.lang.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 - the Issue.
Returns:
The default Value.

updateIssue

public void updateIssue(FieldLayoutItem fieldLayoutItem,
                        MutableIssue issue,
                        java.util.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)

needsMove

public MessagedResult needsMove(java.util.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
Parameters:
originalIssues - Collection of original Issues.
targetIssue - Target Issue.
targetFieldLayoutItem - FieldLayoutItem
Returns:
A MessagedResult with result=true if the field needs input to be moved.

populateForMove

public void populateForMove(java.util.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
Parameters:
fieldValuesHolder - Map of field Values.
originalIssue - orignal Issue
targetIssue - target Issue

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)

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
Parameters:
issue - the Issue.
Returns:
true if the given Issue has a value for this field.

getColumnHeadingKey

public java.lang.String getColumnHeadingKey()
Specified by:
getColumnHeadingKey in interface NavigableField

getDefaultSortOrder

public java.lang.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 java.lang.String getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
                                          java.util.Map displayParams,
                                          Issue issue)
Specified by:
getColumnViewHtml in interface NavigableField

prettyPrintChangeHistory

public java.lang.String prettyPrintChangeHistory(java.lang.String changeHistory)
Specified by:
prettyPrintChangeHistory in interface NavigableField
Overrides:
prettyPrintChangeHistory in class AbstractOrderableNavigableFieldImpl

prettyPrintChangeHistory

public java.lang.String prettyPrintChangeHistory(java.lang.String changeHistory,
                                                 I18nHelper i18nHelper)
Description copied from interface: NavigableField
Used for email notification templates - allows changelog to be displayed in language of the recipient.

Specified by:
prettyPrintChangeHistory in interface NavigableField
Overrides:
prettyPrintChangeHistory in class AbstractOrderableNavigableFieldImpl
Returns:
String change history formatted according to locale in i18nHelper


Copyright © 2002-2010 Atlassian. All Rights Reserved.