com.atlassian.jira.issue.customfields
Class CustomFieldUtils

java.lang.Object
  com.atlassian.jira.issue.customfields.CustomFieldUtils

public class CustomFieldUtils
extends java.lang.Object

Field Summary

static java.lang.String

CUSTOM_FIELD_PREFIX

Constructor Summary

CustomFieldUtils()

Method Summary

static java.util.List<org.ofbiz.core.entity.GenericValue>	buildIssueTypes(ConstantsManager constantsManager1, java.lang.String[] issueTypes)
static java.util.List<JiraContextNode>	buildJiraIssueContexts(boolean global, java.lang.Long[] projectCategories, java.lang.Long[] projects, JiraContextTreeManager treeManager)
static java.util.List<JiraContextNode>	buildJiraIssueContexts(java.lang.String basicScope, java.lang.Long[] projectCategories, java.lang.Long[] projects, java.lang.String[] issuetypes, java.util.List<org.ofbiz.core.entity.GenericValue> returnIssueTypes, JiraContextTreeManager treeManager)
static java.util.Map<java.lang.String,java.lang.Object>	buildParams(CustomField customField, FieldConfig config, Issue issue, FieldLayoutItem fieldLayoutItem, java.lang.Object value, java.util.Map customFieldValuesHolder, webwork.action.Action action, java.util.Map displayParameters)
static java.util.List<IssueContext>	convertToIssueContexts(org.ofbiz.core.entity.GenericValue project, java.util.List<java.lang.String> issueTypeIds, ConstantsManager constantsManager) Deprecated. Please use one of the other variants of this method without GenericValue. Deprecated since v4.0
static java.util.List<IssueContext>	convertToIssueContexts(Project project, java.util.List<java.lang.String> issueTypeIds) Converts list of issue type ids to IssueContexts.
static java.lang.Long	getCustomFieldId(java.lang.String key) Given a custom field key, return its id or null.
static java.lang.String	getCustomFieldKey(java.lang.String searchParamKey)
static java.lang.String	getDateFormat()
static java.lang.String	getDateTimeFormat()
static java.lang.String	getSearchParamSuffix(java.lang.String searchParamKey)
static java.lang.String	getTimeFormat()
static org.apache.commons.collections.MultiMap	invertMap(java.util.Map mapToInvert)
static boolean	isCollectionNotEmpty(java.util.Collection stringCollection)
static boolean	isShownAndVisible(CustomField customField, com.opensymphony.user.User user, SearchContext searchContext, FieldVisibilityManager fieldVisibilityManager) Checks if the custom field is in the search context scope (using OrderableField.isShown(com.atlassian.jira.issue.Issue)) and visible in all field schemes (using FieldVisibilityManager.isFieldHiddenInAllSchemes(String,com.atlassian.jira.issue.search.SearchContext,com.opensymphony.user.User))
static boolean	isUserHasPermissionToProjects(CustomField customField, com.opensymphony.user.User user) Does the user have permission to at least one project that falls under this custom field.
static java.util.Map<CustomField,java.lang.Object>	parseCustomFieldValuesFromActionParams(java.util.Map actionParameters, java.util.List<CustomField> customFields) Parses action parameters (Map of Collections of Strings with [:]> as key)
static java.lang.String	prettyPrintOptions(Options options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CUSTOM_FIELD_PREFIX

public static final java.lang.String CUSTOM_FIELD_PREFIX

See Also:

Constant Field Values

Constructor Detail

CustomFieldUtils

public CustomFieldUtils()

Method Detail

getSearchParamSuffix

public static java.lang.String getSearchParamSuffix(java.lang.String searchParamKey)

getCustomFieldKey

public static java.lang.String getCustomFieldKey(java.lang.String searchParamKey)

getCustomFieldId

public static java.lang.Long getCustomFieldId(java.lang.String key)

Given a custom field key, return its id or null.

Parameters:

key - eg. "customfield_10000"

Returns:

Id, eg. 10000

isCollectionNotEmpty

public static boolean isCollectionNotEmpty(java.util.Collection stringCollection)

parseCustomFieldValuesFromActionParams

public static java.util.Map<CustomField,java.lang.Object> parseCustomFieldValuesFromActionParams(java.util.Map actionParameters,
                                                                                                 java.util.List<CustomField> customFields)

Parses action parameters (Map of Collections of Strings with [:]> as key)

Parameters:

actionParameters - map of action parameters

customFields - a list of custom fields

Returns:

a map of custom field to its value, never null

Since:

3.1-DEV

buildJiraIssueContexts

public static java.util.List<JiraContextNode> buildJiraIssueContexts(boolean global,
                                                                     java.lang.Long[] projectCategories,
                                                                     java.lang.Long[] projects,
                                                                     JiraContextTreeManager treeManager)

buildJiraIssueContexts

public static java.util.List<JiraContextNode> buildJiraIssueContexts(java.lang.String basicScope,
                                                                     java.lang.Long[] projectCategories,
                                                                     java.lang.Long[] projects,
                                                                     java.lang.String[] issuetypes,
                                                                     java.util.List<org.ofbiz.core.entity.GenericValue> returnIssueTypes,
                                                                     JiraContextTreeManager treeManager)

invertMap

public static org.apache.commons.collections.MultiMap invertMap(java.util.Map mapToInvert)

buildIssueTypes

public static java.util.List<org.ofbiz.core.entity.GenericValue> buildIssueTypes(ConstantsManager constantsManager1,
                                                                                 java.lang.String[] issueTypes)

convertToIssueContexts

public static java.util.List<IssueContext> convertToIssueContexts(org.ofbiz.core.entity.GenericValue project,
                                                                  java.util.List<java.lang.String> issueTypeIds,
                                                                  ConstantsManager constantsManager)

Deprecated. Please use one of the other variants of this method without GenericValue. Deprecated since v4.0

Converts list of issue type ids to IssueContexts.

Parameters:

project - project generic value

issueTypeIds - Type ids as strings, eg. ["3", "4"]

constantsManager - constants manager

Returns:

a list of issue contexts, never null

convertToIssueContexts

public static java.util.List<IssueContext> convertToIssueContexts(Project project,
                                                                  java.util.List<java.lang.String> issueTypeIds)

Converts list of issue type ids to IssueContexts.

Parameters:

project - The project (may be null).

issueTypeIds - Type ids as strings, eg. ["3", "4"]. May be null or empty.

Returns:

a list of issue contexts, never null

isUserHasPermissionToProjects

public static boolean isUserHasPermissionToProjects(CustomField customField,
                                                    com.opensymphony.user.User user)

Does the user have permission to at least one project that falls under this custom field. If the custom field has not been configured for anything, it won't return true either

Parameters:

customField - custom field

user - user

Returns:

true if user has permission to at least one project that falls under this custom field, false otherwise

prettyPrintOptions

public static java.lang.String prettyPrintOptions(Options options)

buildParams

public static java.util.Map<java.lang.String,java.lang.Object> buildParams(CustomField customField,
                                                                           FieldConfig config,
                                                                           Issue issue,
                                                                           FieldLayoutItem fieldLayoutItem,
                                                                           java.lang.Object value,
                                                                           java.util.Map customFieldValuesHolder,
                                                                           webwork.action.Action action,
                                                                           java.util.Map displayParameters)

getDateFormat

public static java.lang.String getDateFormat()

getDateTimeFormat

public static java.lang.String getDateTimeFormat()

getTimeFormat

public static java.lang.String getTimeFormat()

isShownAndVisible

public static boolean isShownAndVisible(CustomField customField,
                                        com.opensymphony.user.User user,
                                        SearchContext searchContext,
                                        FieldVisibilityManager fieldVisibilityManager)

Checks if the custom field is in the search context scope (using OrderableField.isShown(com.atlassian.jira.issue.Issue)) and visible in all field schemes (using FieldVisibilityManager.isFieldHiddenInAllSchemes(String,com.atlassian.jira.issue.search.SearchContext,com.opensymphony.user.User))

Parameters:

customField - customfield to check visibility of

user - current user

searchContext - search context

fieldVisibilityManager - field visibility bean

Returns:

true if the customfield is in scope and visibile in all schemes in the specified search context

See Also:

OrderableField.isShown(com.atlassian.jira.issue.Issue), FieldVisibilityManager.isFieldHiddenInAllSchemes(String,com.atlassian.jira.issue.search.SearchContext,com.opensymphony.user.User)