com.atlassian.jira.issue.customfields
Class CustomFieldUtils

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

public class CustomFieldUtils
extends Object

Field Summary

static String

CUSTOM_FIELD_PREFIX

Constructor Summary

CustomFieldUtils()

Method Summary

static List	buildIssueTypes(ConstantsManager constantsManager1, String[] issueTypes)
static List	buildJiraIssueContexts(boolean global, Long[] projectCategories, Long[] projects, JiraContextTreeManager treeManager)
static List	buildJiraIssueContexts(String basicScope, Long[] projectCategories, Long[] projects, String[] issuetypes, List returnIssueTypes, JiraContextTreeManager treeManager)
static Map	buildParams(CustomField customField, FieldConfig config, Issue issue, FieldLayoutItem fieldLayoutItem, Object value, Map customFieldValuesHolder, webwork.action.Action action, Map displayParameters)
static List	convertToIssueContexts(org.ofbiz.core.entity.GenericValue project, List issueTypeIds, ConstantsManager constantsManager) Converts list of issue type ids to issue contexts
static Long	getCustomFieldId(String key) Given a custom field key, return its id.
static String	getCustomFieldKey(String searchParamKey)
static String	getDateFormat()
static String	getDateTimeFormat()
static String	getSearchParamSuffix(String searchParamKey)
static String	getTimeFormat()
static org.apache.commons.collections.MultiMap	invertMap(Map mapToInvert)
static boolean	isCollectionNotEmpty(Collection stringCollection)
static boolean	isShownAndVisible(CustomField customField, User user, SearchContext searchContext, FieldVisibilityBean fieldVisibilityBean) 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 FieldVisibilityBean.isFieldHiddenInAllSchemes(String,com.atlassian.jira.issue.search.SearchContext,com.opensymphony.user.User))
static boolean	isUserHasPermissionToProjects(CustomField customField, User user) Does the user have permission to at least one project that falls under this custom field.
static Map	parseCustomFieldValuesFromActionParams(Map actionParameters, List customFields) Parses action paramaters (Map of Collections of Strings with [:]> as key)
static 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 String CUSTOM_FIELD_PREFIX

See Also:

Constant Field Values

Constructor Detail

CustomFieldUtils

public CustomFieldUtils()

Method Detail

getSearchParamSuffix

public static String getSearchParamSuffix(String searchParamKey)

getCustomFieldKey

public static String getCustomFieldKey(String searchParamKey)

getCustomFieldId

public static Long getCustomFieldId(String key)

Given a custom field key, return its id.

Parameters:

key - eg. "customfield_10000"

Returns:

Id, eg. 10000

isCollectionNotEmpty

public static boolean isCollectionNotEmpty(Collection stringCollection)

parseCustomFieldValuesFromActionParams

public static Map parseCustomFieldValuesFromActionParams(Map actionParameters,
                                                         List customFields)

Parses action paramaters (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 List buildJiraIssueContexts(boolean global,
                                          Long[] projectCategories,
                                          Long[] projects,
                                          JiraContextTreeManager treeManager)

buildJiraIssueContexts

public static List buildJiraIssueContexts(String basicScope,
                                          Long[] projectCategories,
                                          Long[] projects,
                                          String[] issuetypes,
                                          List returnIssueTypes,
                                          JiraContextTreeManager treeManager)

invertMap

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

buildIssueTypes

public static List buildIssueTypes(ConstantsManager constantsManager1,
                                   String[] issueTypes)

convertToIssueContexts

public static List convertToIssueContexts(org.ofbiz.core.entity.GenericValue project,
                                          List issueTypeIds,
                                          ConstantsManager constantsManager)

Converts list of issue type ids to issue contexts

Parameters:

project - project generic value

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

constantsManager - constants manager

Returns:

a list of issue contexts, never null

isUserHasPermissionToProjects

public static boolean isUserHasPermissionToProjects(CustomField customField,
                                                    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 String prettyPrintOptions(Options options)

buildParams

public static Map buildParams(CustomField customField,
                              FieldConfig config,
                              Issue issue,
                              FieldLayoutItem fieldLayoutItem,
                              Object value,
                              Map customFieldValuesHolder,
                              webwork.action.Action action,
                              Map displayParameters)

getDateFormat

public static String getDateFormat()

getDateTimeFormat

public static String getDateTimeFormat()

getTimeFormat

public static String getTimeFormat()

isShownAndVisible

public static boolean isShownAndVisible(CustomField customField,
                                        User user,
                                        SearchContext searchContext,
                                        FieldVisibilityBean fieldVisibilityBean)

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

fieldVisibilityBean - 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), FieldVisibilityBean.isFieldHiddenInAllSchemes(String,com.atlassian.jira.issue.search.SearchContext,com.opensymphony.user.User)