Package com.atlassian.jira.issue.fields

Class MockOrderableField<V>

java.lang.Object
com.atlassian.jira.issue.fields.MockOrderableField<V>
All Implemented Interfaces:
Field, OrderableField<V>, SearchableField, Comparable
public class MockOrderableField<V> extends Object implements OrderableField<V>
A very simple OrderableField field.
Since:
v4.1

  • Constructor Details

    • MockOrderableField

      public MockOrderableField(String id)

    • MockOrderableField

      public MockOrderableField(String id, String name)

  • Method Details

    • setId

      public MockOrderableField setId(String id)

    • setName

      public MockOrderableField setName(String name)

    • getCreateHtml

      public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue)
      Description copied from interface: OrderableField
      Returns the HTML that should be shown when the issue is being created.
      Specified by:
      getCreateHtml in interface OrderableField<V>
      Parameters:
      fieldLayoutItem - FieldLayoutItem
      operationContext - OperationContext
      action - Action
      issue - Issue
      Returns:
      the HTML that should be shown when the issue is being created.

    • 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<V>
      Parameters:
      fieldLayoutItem - FieldLayoutItem
      operationContext - OperationContext
      action - Action
      issue - Issue
      displayParameters - Map of display parameters.
      Returns:
      the HTML that should be shown when the issue is being created.

    • getEditHtml

      public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue)
      Description copied from interface: OrderableField
      Returns HTML that should be shown when the issue is being edited.
      Specified by:
      getEditHtml in interface OrderableField<V>
      Parameters:
      fieldLayoutItem - FieldLayoutItem
      operationContext - OperationContext
      action - Action
      issue - Issue
      Returns:
      HTML that should be shown when the issue is being edited.

    • 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<V>
      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.

    • 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<V>
      Parameters:
      operationContext - OperationContext
      action - Action
      bulkEditBean - BulkEditBean
      displayParameters - Map of display parameters.
      Returns:
      HTML that should be shown when the issue is being edited.

    • getViewHtml

      public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue)
      Specified by:
      getViewHtml in interface OrderableField<V>

    • getViewHtml

      public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
      Specified by:
      getViewHtml in interface OrderableField<V>

    • getViewHtml

      public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Object value, Map displayParameters)
      Specified by:
      getViewHtml in interface OrderableField<V>

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

    • setShown

      public MockOrderableField setShown(boolean shown)

    • 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<V>
      Parameters:
      fieldValuesHolder - The fieldValuesHolder Map to be populated.
      issue - The Issue.

    • hasParam

      public boolean hasParam(Map parameters)
      Description copied from interface: OrderableField
      Checks to see if the (web) parameters contains a relevant value with which to populate the issue
      Specified by:
      hasParam in interface OrderableField<V>
      Parameters:
      parameters - Map of HTTP request parameters ("Action parameters").

    • populateFromParams

      public void populateFromParams(Map fieldValuesHolder, Map parameters)
      Description copied from interface: OrderableField
      Populate the fieldValuesHolder with a value from (web) parameters.
      Specified by:
      populateFromParams in interface OrderableField<V>
      Parameters:
      fieldValuesHolder - The fieldValuesHolder Map to be populated.
      parameters - Map of HTTP parameters.

    • 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 the Edit Issue screen to show the issue's current values.
      Specified by:
      populateFromIssue in interface OrderableField<V>
      Parameters:
      fieldValuesHolder - The fieldValuesHolder Map to be populated.
      issue - The Issue.

    • validateParams

      public void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
      Description copied from interface: OrderableField
      Ensure that the parameters are valid
      Specified by:
      validateParams in interface OrderableField<V>
      Parameters:
      operationContext - OperationContext
      errorCollectionToAddTo - 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

    • getDefaultValue

      public V 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<V>
      Parameters:
      issue - the Issue.
      Returns:
      The default value. It can be null, or an empty collection.

    • 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<V>
      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.

      Fields that are simply stored in the JIRAISSUE DB table, need not do anything here as this table is written to one time to include all fields that changed. Fields using other DB tables must update that table with the appropriate values.

      Specified by:
      updateValue in interface OrderableField<V>
      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.

    • 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<V>
      Parameters:
      fieldLayoutItem - FieldLayoutItem
      issue - MutableIssue
      fieldValueHolder - Field Value Holder Map
      See Also:

    • 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<V>
      Parameters:
      issue - The issue object to be effected.
      See Also:

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

      • The OrderableField can sometimes remove the value, but it decides that it is not relevant for this Issue. eg: Security Level will ignore remove requests on a subtask, as the subtask Security is not set explicitly (it is always inherited from its parent issue).
      • It may possible to remove this value, but the OrderableField does not actually do the job, it is done through some special mechanism. eg Attachments.
      • This field is some special system field which it is invalid to remove. eg Project. In these cases calling removeValueFromIssueObject() would normally raise an UnsupportedOperationException.
      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<V>
      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:

    • 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<V>
      Parameters:
      originalIssues - Collection of original Issues.
      targetIssue - Nonexistent issue object with values representing those of issue(s) after move
      targetFieldLayoutItem - FieldLayoutItem
      Returns:
      A MessagedResult with result=true if the field needs input to be moved.

    • populateForMove

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

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

    • 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<V>
      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.

    • getValueFromParams

      public V getValueFromParams(Map params) throws FieldValidationException
      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<V>
      Parameters:
      params - the map of parameters.
      Returns:
      Value for this field from the map of parameters.
      Throws:
      FieldValidationException - if there is a problem with Field Validation.

    • 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<V>
      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

    • createAssociatedSearchHandler

      public SearchHandler createAssociatedSearchHandler()
      Description copied from interface: SearchableField
      Return SearchHandler for the field. This object tells JIRA how to search for values within the field.
      Specified by:
      createAssociatedSearchHandler in interface SearchableField
      Returns:
      the SearchHandler associated with the field. Can return null when no searcher is associated with the field. This will mainly happen when a customfield is configured to have no searcher.

    • getId

      public String getId()
      Description copied from interface: Field
      The unique id of the field
      Specified by:
      getId in interface Field

    • getNameKey

      public String getNameKey()
      Description copied from interface: Field
      The i18n key that is used to lookup the field's name when it is displayed
      Specified by:
      getNameKey in interface Field

    • getName

      public String getName()
      Description copied from interface: Field
      Returns i18n'ed name of the field.
      Specified by:
      getName in interface Field

    • compareTo

      public int compareTo(Object o)
      Specified by:
      compareTo in interface Comparable<V>

    • toString

      public String toString()
      Overrides:
      toString in class Object