Package com.atlassian.jira.issue.fields

Class SecurityLevelSystemField

java.lang.Object
com.atlassian.jira.issue.fields.AbstractField
com.atlassian.jira.issue.fields.AbstractOrderableField<org.ofbiz.core.entity.GenericValue>
com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl<org.ofbiz.core.entity.GenericValue>
com.atlassian.jira.issue.fields.SecurityLevelSystemField
All Implemented Interfaces:
ExportableSystemField, Field, HideableField, NavigableField, OrderableField<org.ofbiz.core.entity.GenericValue>, RequirableField, RestAwareField, RestFieldOperations, SearchableField, Comparable
public class SecurityLevelSystemField extends AbstractOrderableNavigableFieldImpl<org.ofbiz.core.entity.GenericValue> implements HideableField, RequirableField, RestAwareField, RestFieldOperations, ExportableSystemField

  • Constructor Details

  • Method Details

    • 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<org.ofbiz.core.entity.GenericValue>
      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, 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<org.ofbiz.core.entity.GenericValue>
      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 class: AbstractOrderableField
      Returns HTML that should be shown when the issue is being bulk edited. By default calls the OrderableField.getEditHtml(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.customfields.OperationContext, webwork.action.Action, com.atlassian.jira.issue.Issue, java.util.Map) method with null for FieldLayoutItem and the first issue in the collection}
      Specified by:
      getBulkEditHtml in interface OrderableField<org.ofbiz.core.entity.GenericValue>
      Overrides:
      getBulkEditHtml in class AbstractOrderableField<org.ofbiz.core.entity.GenericValue>
      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, Map displayParameters)
      Specified by:
      getViewHtml in interface OrderableField<org.ofbiz.core.entity.GenericValue>

    • getViewHtml

      public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, org.ofbiz.core.entity.GenericValue value, Map displayParameters)
      Specified by:
      getViewHtml in interface OrderableField<org.ofbiz.core.entity.GenericValue>

    • 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<org.ofbiz.core.entity.GenericValue>
      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.

    • 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<org.ofbiz.core.entity.GenericValue>
      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 org.ofbiz.core.entity.GenericValue 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<org.ofbiz.core.entity.GenericValue>
      Parameters:
      issue - the Issue.
      Returns:
      The default value. It can be null, or an empty collection.

    • updateValue

      public void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
      Update the issue
      Specified by:
      updateValue in interface OrderableField<org.ofbiz.core.entity.GenericValue>
      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.

    • createValue

      public void createValue(Issue issue, org.ofbiz.core.entity.GenericValue value)
      Description copied from interface: OrderableField
      Create the value of the issue in the data store.
      Specified by:
      createValue in interface OrderableField<org.ofbiz.core.entity.GenericValue>
      Parameters:
      issue - Issue this field is part of
      value - Value to store in this field (eg. Collection for Version fields). Cannot be null.

    • getValueFromParams

      public org.ofbiz.core.entity.GenericValue 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<org.ofbiz.core.entity.GenericValue>
      Parameters:
      params - the map of parameters.
      Returns:
      Value for this field from the map of parameters.

    • populateParamsFromString

      public void populateParamsFromString(Map<String,Object> 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<org.ofbiz.core.entity.GenericValue>
      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

    • getAssociatedSearchers

      public List<IssueSearcher<?>> getAssociatedSearchers()

    • getRelevantParams

      protected Object getRelevantParams(Map<String,String[]> params)
      Specified by:
      getRelevantParams in class AbstractOrderableField<org.ofbiz.core.entity.GenericValue>

    • populateFromIssue

      public void populateFromIssue(Map<String,Object> 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<org.ofbiz.core.entity.GenericValue>
      Parameters:
      fieldValuesHolder - The fieldValuesHolder Map to be populated.
      issue - The Issue.

    • populateDefaults

      public void populateDefaults(Map<String,Object> 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<org.ofbiz.core.entity.GenericValue>
      Parameters:
      fieldValuesHolder - The fieldValuesHolder Map to be populated.
      issue - The Issue.

    • 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<org.ofbiz.core.entity.GenericValue>
      Parameters:
      issue - The Issue.
      Returns:
      true if it should be shown.

    • getSecurityScheme

      protected org.ofbiz.core.entity.GenericValue getSecurityScheme(org.ofbiz.core.entity.GenericValue project)

    • 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<org.ofbiz.core.entity.GenericValue>
      Parameters:
      fieldLayoutItem - FieldLayoutItem
      issue - MutableIssue
      fieldValueHolder - Field Value Holder Map
      See Also:

    • needsMove

      public MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
      We want to prompt the user for a change if the Security Level scheme is changing due to a change in project, or if the issue used to have no security level, and the Project it is being moved to has a non-null default security level. This will also return true, if the original issue has an issue level set, but the user does not have permission to see that security level in the target project. Finally, if no security level has been set in the source issue, and the target project requires a security level, this will also return true.
      Specified by:
      needsMove in interface OrderableField<org.ofbiz.core.entity.GenericValue>
      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<org.ofbiz.core.entity.GenericValue>
      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<org.ofbiz.core.entity.GenericValue>
      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<org.ofbiz.core.entity.GenericValue>
      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:

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

    • 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

    • getFieldSorts

      public List<FieldSort> getFieldSorts(FieldSort.Order sortOrder)
      Description copied from interface: NavigableField
      Returns a list of FieldSort objects that can be used to sort this field.
      Specified by:
      getFieldSorts in interface NavigableField
      Parameters:
      sortOrder - the order in which to sort the field
      Returns:
      a list of FieldSort objects that can be used to sort this field

    • getValueLoader

      public FieldValueLoader getValueLoader()
      Description copied from interface: NavigableField
      A loader to be used when loading the value of the field from the index.
      Specified by:
      getValueLoader in interface NavigableField
      Returns:
      A loader that can be used to load the value of the field
      See Also:

    • getColumnViewHtml

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

    • getFieldTypeInfo

      public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
      Description copied from interface: RestAwareField
      Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url
      Specified by:
      getFieldTypeInfo in interface RestAwareField
      Parameters:
      fieldTypeInfoContext - the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfo

    • getJsonSchema

      public JsonType getJsonSchema()
      Description copied from interface: RestAwareField
      Return a description of the shape of this field when represented as JSON.
      Specified by:
      getJsonSchema in interface RestAwareField

    • getSecurityLevelJsonSchema

      public static JsonType getSecurityLevelJsonSchema()

    • getJsonFromIssue

      public FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequired, FieldLayoutItem fieldLayoutItem)
      Description copied from interface: RestAwareField
      Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.
      Specified by:
      getJsonFromIssue in interface RestAwareField
      Parameters:
      issue - to get field data from
      renderedVersionRequired - whether the use requested the return of rendered/pretty data as well as raw data
      fieldLayoutItem - field layout for this field. Will only be supplied if the field is also an ordereable field.
      Returns:
      FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

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

    • getRepresentationFromIssue

      public FieldExportParts getRepresentationFromIssue(Issue issue)
      Description copied from interface: ExportableSystemField
      For the given issue get an exportable representation for the field
      Specified by:
      getRepresentationFromIssue in interface ExportableSystemField
      Parameters:
      issue - to get representation for the field
      Returns:
      the fields exportable representation